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

bound session cache #195

Merged
merged 3 commits into from
Apr 8, 2024
Merged

bound session cache #195

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6ce9f3b
bound session cache
ehaydenr Nov 28, 2022
599ca72
HttpsLayerSettings
ehaydenr Dec 1, 2023
452b1bc
builder
ehaydenr Dec 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
18 changes: 13 additions & 5 deletions hyper-boring/src/cache.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,24 +40,32 @@ impl Borrow<[u8]> for HashSession {
pub struct SessionCache {
sessions: HashMap<SessionKey, LinkedHashSet<HashSession>>,
reverse: HashMap<HashSession, SessionKey>,
/// Maximum capacity of LinkedHashSet per SessionKey
per_key_session_capacity: usize,
}

impl SessionCache {
pub fn new() -> SessionCache {
pub fn with_capacity(per_key_session_capacity: usize) -> SessionCache {
SessionCache {
sessions: HashMap::new(),
reverse: HashMap::new(),
per_key_session_capacity,
}
}

pub fn insert(&mut self, key: SessionKey, session: SslSession) {
let session = HashSession(session);

self.sessions
.entry(key.clone())
.or_default()
.insert(session.clone());
let sessions = self.sessions.entry(key.clone()).or_default();

// if sessions exceed capacity, discard oldest
if sessions.len() >= self.per_key_session_capacity {
if let Some(hash) = sessions.pop_front() {
self.reverse.remove(&hash);
}
}

sessions.insert(session.clone());
self.reverse.insert(session, key);
}

Expand Down
20 changes: 13 additions & 7 deletions hyper-boring/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,19 @@ impl HttpsLayer {
/// Creates a new `HttpsLayer`.
///
/// The session cache configuration of `ssl` will be overwritten.
pub fn with_connector(mut ssl: SslConnectorBuilder) -> Result<HttpsLayer, ErrorStack> {
let cache = Arc::new(Mutex::new(SessionCache::new()));
pub fn with_connector(ssl: SslConnectorBuilder) -> Result<HttpsLayer, ErrorStack> {
Self::with_connector_and_capacity(ssl, 8)
}

/// Creates a new `HttpsLayer` with session capacity.
///
/// The session cache configuration of `ssl` will be overwritten. Session capacity is per
/// session key (domain).
pub fn with_connector_and_capacity(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's make it future-proof and use settings struct here:

struct HttpsLayerSettings {
    session_cache_capacity: usize
}

and change this to:

pub fn with_connector_and_settings(...)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. Updated

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doing it that way adding a field to HttpsLayerSettings is still a breaking change so it's not really future-proof. We may want a builder instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

makes sense, updated!

mut ssl: SslConnectorBuilder,
capacity: usize,
) -> Result<HttpsLayer, ErrorStack> {
let cache = Arc::new(Mutex::new(SessionCache::with_capacity(capacity)));

ssl.set_session_cache_mode(SslSessionCacheMode::CLIENT);

Expand All @@ -107,11 +118,6 @@ impl HttpsLayer {
}
});

ssl.set_remove_session_callback({
let cache = cache.clone();
move |_, session| cache.lock().remove(session)
});

Ok(HttpsLayer {
inner: Inner {
ssl: ssl.build(),
Expand Down