Session.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2021 The Squid Software Foundation and contributors
3  *
4  * Squid software is distributed under GPLv2+ license and includes
5  * contributions from numerous individuals and organizations.
6  * Please see the COPYING and CONTRIBUTORS files for details.
7  */
8 
9 #ifndef SQUID_SRC_SECURITY_SESSION_H
10 #define SQUID_SRC_SECURITY_SESSION_H
11 
12 #include "base/HardFun.h"
13 #include "comm/forward.h"
14 #include "security/forward.h"
16 
17 #include <memory>
18 
19 #if USE_OPENSSL
20 #include "compat/openssl.h"
21 #if HAVE_OPENSSL_SSL_H
22 #include <openssl/ssl.h>
23 #endif
24 #endif
25 
26 #if USE_GNUTLS
27 #if HAVE_GNUTLS_GNUTLS_H
28 #include <gnutls/gnutls.h>
29 #endif
30 #endif
31 
32 namespace Security {
33 
36 bool CreateClientSession(const Security::ContextPointer &, const Comm::ConnectionPointer &, const char *squidCtx);
37 
38 class PeerOptions;
39 
43 
44 #if USE_OPENSSL
45 typedef SSL Connection;
46 
47 using Session = SSL_SESSION;
48 
49 typedef std::shared_ptr<SSL> SessionPointer;
50 
51 typedef std::unique_ptr<SSL_SESSION, HardFun<void, SSL_SESSION*, &SSL_SESSION_free>> SessionStatePointer;
52 
53 #elif USE_GNUTLS
54 // to be finalized when it is actually needed/used
55 struct Connection {};
56 
57 // to be finalized when it is actually needed/used
58 struct Session {};
59 
60 typedef std::shared_ptr<struct gnutls_session_int> SessionPointer;
61 
62 // wrapper function to get around gnutls_free being a typedef
63 inline void squid_gnutls_free(void *d) {gnutls_free(d);}
64 typedef std::unique_ptr<gnutls_datum_t, HardFun<void, void*, &Security::squid_gnutls_free>> SessionStatePointer;
65 
66 #else
67 typedef std::nullptr_t Connection;
68 
69 struct Session {};
70 
71 typedef std::shared_ptr<void> SessionPointer;
72 
73 typedef std::unique_ptr<int> SessionStatePointer;
74 
75 #endif
76 
79 
82 
93 
97 
98 #if USE_OPENSSL
99 // TODO: remove from public API. It is only public because of Security::ServerOptions::updateContextConfig
102 
106 {
107  auto *ctx = SSL_get_SSL_CTX(s.get());
108  return Security::ContextPointer(ctx, [](SSL_CTX *) {/* nothing to unlock/free */});
109 }
110 
115 #endif
116 
117 } // namespace Security
118 
119 #endif /* SQUID_SRC_SECURITY_SESSION_H */
120 
bool CreateClientSession(const Security::ContextPointer &, const Comm::ConnectionPointer &, const char *squidCtx)
Definition: Session.cc:183
std::shared_ptr< SSL_CTX > ContextPointer
Definition: Context.h:29
void MaybeGetSessionResumeData(const Security::SessionPointer &, Security::SessionStatePointer &data)
Definition: Session.cc:225
Security::ContextPointer GetFrom(Security::SessionPointer &s)
Helper function to retrieve a (non-locked) ContextPointer from a SessionPointer.
Definition: Session.h:105
void SessionSendGoodbye(const Security::SessionPointer &)
send the shutdown/bye notice for an active TLS session.
Definition: Session.cc:199
bool SessionIsResumed(const Security::SessionPointer &)
whether the session is a resumed one
Definition: Session.cc:212
TLS squid.conf settings for a remote server peer.
Definition: PeerOptions.h:24
void SetSessionCacheCallbacks(Security::ContextPointer &)
Setup the given TLS context with callbacks used to manage the session cache.
Definition: Session.cc:375
Security::SessionPointer NewSessionObject(const Security::ContextPointer &)
Definition: Session.cc:90
SSL Connection
Definition: Session.h:45
bool CreateServerSession(const Security::ContextPointer &, const Comm::ConnectionPointer &, Security::PeerOptions &, const char *squidCtx)
Definition: Session.cc:193
std::shared_ptr< SSL > SessionPointer
Definition: Session.h:49
std::unique_ptr< SSL_SESSION, HardFun< void, SSL_SESSION *, &SSL_SESSION_free > > SessionStatePointer
Definition: Session.h:51
SSL_SESSION Session
Definition: Session.h:47
static StatHist s
Network/connection security abstraction layer.
Definition: Connection.h:34
void SetSessionResumeData(const Security::SessionPointer &, const Security::SessionStatePointer &)
Definition: Session.cc:246

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors