gadgets.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 1996-2022 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_SSL_GADGETS_H
10#define SQUID_SSL_GADGETS_H
11
12#if USE_OPENSSL
13
14#include "base/HardFun.h"
15#include "compat/openssl.h"
16#include "security/forward.h"
17#include "ssl/crtd_message.h"
18
19#include <string>
20
21#if HAVE_OPENSSL_ASN1_H
22#include <openssl/asn1.h>
23#endif
24#if HAVE_OPENSSL_TXT_DB_H
25#include <openssl/txt_db.h>
26#endif
27#if HAVE_OPENSSL_X509V3_H
28#include <openssl/x509v3.h>
29#endif
30
31namespace Ssl
32{
39#if !defined(SQUID_SSL_SIGN_HASH_IF_NONE)
40#define SQUID_SSL_SIGN_HASH_IF_NONE "sha256"
41#endif
42
46sk_dtor_wrapper(sk_X509, STACK_OF(X509) *, X509_free);
47typedef std::unique_ptr<STACK_OF(X509), sk_X509_free_wrapper> X509_STACK_Pointer;
48
49typedef std::unique_ptr<BIGNUM, HardFun<void, BIGNUM*, &BN_free>> BIGNUM_Pointer;
50
51typedef std::unique_ptr<BIO, HardFun<void, BIO*, &BIO_vfree>> BIO_Pointer;
52
53typedef std::unique_ptr<ASN1_INTEGER, HardFun<void, ASN1_INTEGER*, &ASN1_INTEGER_free>> ASN1_INT_Pointer;
54
55typedef std::unique_ptr<ASN1_OCTET_STRING, HardFun<void, ASN1_OCTET_STRING*, &ASN1_OCTET_STRING_free>> ASN1_OCTET_STRING_Pointer;
56
57typedef std::unique_ptr<TXT_DB, HardFun<void, TXT_DB*, &TXT_DB_free>> TXT_DB_Pointer;
58
59typedef std::unique_ptr<X509_NAME, HardFun<void, X509_NAME*, &X509_NAME_free>> X509_NAME_Pointer;
60
61using EVP_PKEY_CTX_Pointer = std::unique_ptr<EVP_PKEY_CTX, HardFun<void, EVP_PKEY_CTX*, &EVP_PKEY_CTX_free>>;
62
63typedef std::unique_ptr<X509_REQ, HardFun<void, X509_REQ*, &X509_REQ_free>> X509_REQ_Pointer;
64
65typedef std::unique_ptr<AUTHORITY_KEYID, HardFun<void, AUTHORITY_KEYID*, &AUTHORITY_KEYID_free>> AUTHORITY_KEYID_Pointer;
66
67sk_dtor_wrapper(sk_GENERAL_NAME, STACK_OF(GENERAL_NAME) *, GENERAL_NAME_free);
68typedef std::unique_ptr<STACK_OF(GENERAL_NAME), sk_GENERAL_NAME_free_wrapper> GENERAL_NAME_STACK_Pointer;
69
70typedef std::unique_ptr<GENERAL_NAME, HardFun<void, GENERAL_NAME*, &GENERAL_NAME_free>> GENERAL_NAME_Pointer;
71
72typedef std::unique_ptr<X509_EXTENSION, HardFun<void, X509_EXTENSION*, &X509_EXTENSION_free>> X509_EXTENSION_Pointer;
73
74typedef std::unique_ptr<X509_STORE_CTX, HardFun<void, X509_STORE_CTX *, &X509_STORE_CTX_free>> X509_STORE_CTX_Pointer;
75
76// not using CtoCpp1() here because OpenSSL_free() takes void* rather than char*
77inline void OPENSSL_free_for_c_strings(char * const string) { OPENSSL_free(string); }
78using UniqueCString = std::unique_ptr<char, HardFun<void, char *, &OPENSSL_free_for_c_strings> >;
79
81void ForgetErrors();
82
87std::ostream &ReportAndForgetErrors(std::ostream &);
88
93bool writeCertAndPrivateKeyToMemory(Security::CertPointer const & cert, Security::PrivateKeyPointer const & pkey, std::string & bufferToWrite);
94
99bool appendCertToMemory(Security::CertPointer const & cert, std::string & bufferToWrite);
100
105bool readCertAndPrivateKeyFromMemory(Security::CertPointer & cert, Security::PrivateKeyPointer & pkey, char const * bufferToRead);
106
109BIO_Pointer ReadOnlyBioTiedTo(const char *);
110
115void ReadPrivateKeyFromFile(char const * keyFilename, Security::PrivateKeyPointer &pkey, pem_password_cb *passwd_callback);
116
121bool OpenCertsFileForReading(BIO_Pointer &bio, const char *filename);
122
126
130
135bool ReadPrivateKey(BIO_Pointer &bio, Security::PrivateKeyPointer &pkey, pem_password_cb *passwd_callback);
136
142bool OpenCertsFileForWriting(BIO_Pointer &bio, const char *filename);
143
149
154bool WritePrivateKey(BIO_Pointer &bio, const Security::PrivateKeyPointer &pkey);
155
157UniqueCString OneLineSummary(X509_NAME &);
158
164
170extern const char *CertSignAlgorithmStr[];
171
176inline const char *certSignAlgorithm(int sg)
177{
178 if (sg >=0 && sg < Ssl::algSignEnd)
179 return Ssl::CertSignAlgorithmStr[sg];
180
181 return nullptr;
182}
183
189{
190 for (int i = 0; i < algSignEnd && Ssl::CertSignAlgorithmStr[i] != nullptr; i++)
191 if (strcmp(Ssl::CertSignAlgorithmStr[i], sg) == 0)
192 return (CertSignAlgorithm)i;
193
194 return algSignEnd;
195}
196
202
207extern const char *CertAdaptAlgorithmStr[];
208
213inline const char *sslCertAdaptAlgoritm(int alg)
214{
215 if (alg >=0 && alg < Ssl::algSetEnd)
216 return Ssl::CertAdaptAlgorithmStr[alg];
217
218 return nullptr;
219}
220
226{
227public:
231 Security::PrivateKeyPointer signWithPkey;
235 std::string commonName;
237 const EVP_MD *signHash;
238private:
241};
242
245std::string & OnDiskCertificateDbKey(const CertificateProperties &);
246
254bool generateSslCertificate(Security::CertPointer & cert, Security::PrivateKeyPointer & pkey, CertificateProperties const &properties);
255
261bool sslDateIsInTheFuture(char const * date);
262
269bool certificateMatchesProperties(X509 *peer_cert, CertificateProperties const &properties);
270
276const char *CommonHostName(X509 *x509);
277
283const char *getOrganization(X509 *x509);
284
287bool CertificatesCmp(const Security::CertPointer &cert1, const Security::CertPointer &cert2);
288
291const ASN1_BIT_STRING *X509_get_signature(const Security::CertPointer &);
292
293} // namespace Ssl
294
295#endif // USE_OPENSSL
296#endif // SQUID_SSL_GADGETS_H
297
Security::PrivateKeyPointer signWithPkey
The key of the signing certificate.
Definition: gadgets.h:231
Security::CertPointer signWithX509
Certificate to sign the generated request.
Definition: gadgets.h:230
bool setCommonName
Replace the CN field of the mimicking subject with the given.
Definition: gadgets.h:234
CertificateProperties(CertificateProperties &)
bool setValidAfter
Do not mimic "Not Valid After" field.
Definition: gadgets.h:232
CertSignAlgorithm signAlgorithm
The signing algorithm to use.
Definition: gadgets.h:236
CertificateProperties & operator=(CertificateProperties const &)
bool setValidBefore
Do not mimic "Not Valid Before" field.
Definition: gadgets.h:233
Security::CertPointer mimicCert
Certificate to mimic.
Definition: gadgets.h:229
const EVP_MD * signHash
The signing hash to use.
Definition: gadgets.h:237
std::string commonName
A CN to use for the generated certificate.
Definition: gadgets.h:235
const char * getOrganization(X509 *x509)
Definition: gadgets.cc:974
const char * CommonHostName(X509 *x509)
Definition: gadgets.cc:969
bool CertificatesCmp(const Security::CertPointer &cert1, const Security::CertPointer &cert2)
Definition: gadgets.cc:980
void ReadPrivateKeyFromFile(char const *keyFilename, Security::PrivateKeyPointer &pkey, pem_password_cb *passwd_callback)
Definition: gadgets.cc:779
bool ReadPrivateKey(BIO_Pointer &bio, Security::PrivateKeyPointer &pkey, pem_password_cb *passwd_callback)
Definition: gadgets.cc:768
bool OpenCertsFileForWriting(BIO_Pointer &bio, const char *filename)
Definition: gadgets.cc:790
bool WritePrivateKey(BIO_Pointer &bio, const Security::PrivateKeyPointer &pkey)
Definition: gadgets.cc:811
CertSignAlgorithm certSignAlgorithmId(const char *sg)
Definition: gadgets.h:188
const char * sslCertAdaptAlgoritm(int alg)
Definition: gadgets.h:213
bool appendCertToMemory(Security::CertPointer const &cert, std::string &bufferToWrite)
Definition: gadgets.cc:121
bool sslDateIsInTheFuture(char const *date)
Definition: gadgets.cc:826
bool OpenCertsFileForReading(BIO_Pointer &bio, const char *filename)
Definition: gadgets.cc:722
std::string & OnDiskCertificateDbKey(const CertificateProperties &)
Definition: gadgets.cc:267
bool generateSslCertificate(Security::CertPointer &cert, Security::PrivateKeyPointer &pkey, CertificateProperties const &properties)
Definition: gadgets.cc:711
CertAdaptAlgorithm
Definition: gadgets.h:201
CertSignAlgorithm
Definition: gadgets.h:163
bool writeCertAndPrivateKeyToMemory(Security::CertPointer const &cert, Security::PrivateKeyPointer const &pkey, std::string &bufferToWrite)
Definition: gadgets.cc:97
bool readCertAndPrivateKeyFromMemory(Security::CertPointer &cert, Security::PrivateKeyPointer &pkey, char const *bufferToRead)
Definition: gadgets.cc:145
bool certificateMatchesProperties(X509 *peer_cert, CertificateProperties const &properties)
Definition: gadgets.cc:878
bool WriteX509Certificate(BIO_Pointer &bio, const Security::CertPointer &cert)
Definition: gadgets.cc:801
const char * CertAdaptAlgorithmStr[]
Definition: gadgets.cc:237
const char * certSignAlgorithm(int sg)
Definition: gadgets.h:176
const char * CertSignAlgorithmStr[]
Definition: gadgets.cc:230
@ algSetValidAfter
Definition: gadgets.h:201
@ algSetCommonName
Definition: gadgets.h:201
@ algSetEnd
Definition: gadgets.h:201
@ algSetValidBefore
Definition: gadgets.h:201
@ algSignEnd
Definition: gadgets.h:163
@ algSignTrusted
Definition: gadgets.h:163
@ algSignUntrusted
Definition: gadgets.h:163
@ algSignSelf
Definition: gadgets.h:163
Definition: Xaction.cc:49
std::unique_ptr< EVP_PKEY_CTX, HardFun< void, EVP_PKEY_CTX *, &EVP_PKEY_CTX_free > > EVP_PKEY_CTX_Pointer
Definition: gadgets.h:61
std::unique_ptr< GENERAL_NAME, HardFun< void, GENERAL_NAME *, &GENERAL_NAME_free > > GENERAL_NAME_Pointer
Definition: gadgets.h:70
std::unique_ptr< BIO, HardFun< void, BIO *, &BIO_vfree > > BIO_Pointer
Definition: gadgets.h:51
std::unique_ptr< BIGNUM, HardFun< void, BIGNUM *, &BN_free > > BIGNUM_Pointer
Definition: gadgets.h:49
std::unique_ptr< TXT_DB, HardFun< void, TXT_DB *, &TXT_DB_free > > TXT_DB_Pointer
Definition: gadgets.h:57
std::unique_ptr< X509_STORE_CTX, HardFun< void, X509_STORE_CTX *, &X509_STORE_CTX_free > > X509_STORE_CTX_Pointer
Definition: gadgets.h:74
void OPENSSL_free_for_c_strings(char *const string)
Definition: gadgets.h:77
std::unique_ptr< ASN1_OCTET_STRING, HardFun< void, ASN1_OCTET_STRING *, &ASN1_OCTET_STRING_free > > ASN1_OCTET_STRING_Pointer
Definition: gadgets.h:55
std::ostream & ReportAndForgetErrors(std::ostream &)
Definition: gadgets.cc:34
Security::CertPointer ReadOptionalCertificate(const BIO_Pointer &)
Definition: gadgets.cc:733
const ASN1_BIT_STRING * X509_get_signature(const Security::CertPointer &)
Definition: gadgets.cc:1005
UniqueCString OneLineSummary(X509_NAME &)
a RAII wrapper for the memory-allocating flavor of X509_NAME_oneline()
Definition: gadgets.cc:821
Security::CertPointer ReadCertificate(const BIO_Pointer &)
Definition: gadgets.cc:758
std::unique_ptr< X509_REQ, HardFun< void, X509_REQ *, &X509_REQ_free > > X509_REQ_Pointer
Definition: gadgets.h:63
std::unique_ptr< STACK_OF(GENERAL_NAME), sk_GENERAL_NAME_free_wrapper > GENERAL_NAME_STACK_Pointer
Definition: gadgets.h:68
BIO_Pointer ReadOnlyBioTiedTo(const char *)
Definition: gadgets.cc:170
std::unique_ptr< X509_NAME, HardFun< void, X509_NAME *, &X509_NAME_free > > X509_NAME_Pointer
Definition: gadgets.h:59
sk_dtor_wrapper(sk_X509, STACK_OF(X509) *, X509_free)
std::unique_ptr< ASN1_INTEGER, HardFun< void, ASN1_INTEGER *, &ASN1_INTEGER_free > > ASN1_INT_Pointer
Definition: gadgets.h:53
std::unique_ptr< X509_EXTENSION, HardFun< void, X509_EXTENSION *, &X509_EXTENSION_free > > X509_EXTENSION_Pointer
Definition: gadgets.h:72
std::unique_ptr< char, HardFun< void, char *, &OPENSSL_free_for_c_strings > > UniqueCString
Definition: gadgets.h:78
std::unique_ptr< STACK_OF(X509), sk_X509_free_wrapper > X509_STACK_Pointer
Definition: gadgets.h:47
void ForgetErrors()
Clear any errors accumulated by OpenSSL in its global storage.
Definition: gadgets.cc:17
std::unique_ptr< AUTHORITY_KEYID, HardFun< void, AUTHORITY_KEYID *, &AUTHORITY_KEYID_free > > AUTHORITY_KEYID_Pointer
Definition: gadgets.h:65
STACK_OF(X509) *X509_STORE_CTX_get0_untrusted(X509_STORE_CTX *ctx)
Definition: openssl.h:237

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors