Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/session key #307

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Feature/session key #307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d2b7229
Using secrecy 0.8
miketwenty1 Dec 14, 2022
b313f40
todo
miketwenty1 Dec 14, 2022
091a49a
update based on feedback, this is in a broken state
miketwenty1 Jan 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions actix-session/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,10 @@ redis-rs-tls-session = ["redis-rs-session", "redis/tokio-native-tls-comp"]
[dependencies]
actix-service = "2"
actix-utils = "3"
actix-web = { version = "4", default_features = false, features = ["cookies", "secure-cookies"] }
actix-web = { version = "4", default_features = false, features = [
"cookies",
"secure-cookies",
] }

anyhow = "1"
async-trait = "0.1"
Expand All @@ -44,14 +47,27 @@ tracing = { version = "0.1.30", default-features = false, features = ["log"] }
actix = { version = "0.13", default-features = false, optional = true }
actix-redis = { version = "0.12", optional = true }
futures-core = { version = "0.3.7", default-features = false, optional = true }
secrecy = "0.8"

# redis-rs-session
redis = { version = "0.21", default-features = false, features = ["aio", "tokio-comp", "connection-manager"], optional = true }
redis = { version = "0.21", default-features = false, features = [
"aio",
"tokio-comp",
"connection-manager",
], optional = true }

[dev-dependencies]
actix-session = { path = ".", features = ["cookie-session", "redis-actor-session", "redis-rs-session"] }
actix-session = { path = ".", features = [
"cookie-session",
"redis-actor-session",
"redis-rs-session",
] }
actix-test = "0.1.0-beta.10"
actix-web = { version = "4", default_features = false, features = ["cookies", "secure-cookies", "macros"] }
actix-web = { version = "4", default_features = false, features = [
"cookies",
"secure-cookies",
"macros",
] }
env_logger = "0.9"
log = "0.4"

Expand Down
13 changes: 12 additions & 1 deletion actix-session/src/session.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ use anyhow::Context;
use derive_more::{Display, From};
use serde::{de::DeserializeOwned, Serialize};

use crate::storage::SessionKey;

/// The primary interface to access and modify session state.
///
/// [`Session`] is an [extractor](#impl-FromRequest)—you can specify it as an input type for your
Expand Down Expand Up @@ -77,6 +79,7 @@ impl Default for SessionStatus {
struct SessionInner {
state: HashMap<String, String>,
status: SessionStatus,
session_key: Option<SessionKey>,
}

impl Session {
Expand All @@ -101,7 +104,15 @@ impl Session {
Ok(None)
}
}

/// Get a the session key itself from the overall session.
///
/// Retrieve the overall session key
pub fn get_session_key(&self) -> secrecy::Secret<SessionKey> {
todo!("either grab the key or figure out how to populate InnerSession session_key field");
// let key = Session::set_session(&mut self.0., self.0);
let key = self.0.borrow().session_key.clone(); //
secrecy::Secret::new(key.unwrap())
}
/// Get all raw key-value data from the session.
///
/// Note that values are JSON encoded.
Expand Down
19 changes: 13 additions & 6 deletions actix-session/src/storage/session_key.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
use std::convert::TryFrom;

use derive_more::{Display, From};
use secrecy::Secret;

/// A session key, the string stored in a client-side cookie to associate a user with its session
/// state on the backend.
Expand All @@ -17,8 +18,8 @@ use derive_more::{Display, From};
/// let session_key: Result<SessionKey, _> = key.try_into();
/// assert!(session_key.is_err());
/// ```
#[derive(Debug, PartialEq, Eq)]
pub struct SessionKey(String);
#[derive(Debug, Clone)]
pub struct SessionKey(secrecy::Secret<String>);

impl TryFrom<String> for SessionKey {
type Error = InvalidSessionKeyError;
Expand All @@ -30,17 +31,23 @@ impl TryFrom<String> for SessionKey {
)
.into());
}

Ok(SessionKey(val))
let val_secret = Secret::new(val);
Ok(SessionKey(val_secret))
}
}

impl AsRef<str> for SessionKey {
fn as_ref(&self) -> &str {
impl AsRef<secrecy::Secret<String>> for SessionKey {
fn as_ref(&self) -> &secrecy::Secret<String> {
&self.0
}
}

impl secrecy::Zeroize for SessionKey {
fn zeroize(&mut self) {
self.0.zeroize();
}
}

impl From<SessionKey> for String {
fn from(key: SessionKey) -> Self {
key.0
Expand Down