Encapsulate an OpenSSL certificate (UNIX-specific).
More...
#include <tsOpenSSLCertificate.h>
|
| static int | SilentLevel (bool silent) |
| | Compute a log severity level from a "silent" parameter.
|
| |
Encapsulate an OpenSSL certificate (UNIX-specific).
◆ OpenSSLCertificate() [1/2]
| ts::OpenSSLCertificate::OpenSSLCertificate |
( |
Report * |
report, |
|
|
Object * |
owner = nullptr |
|
) |
| |
|
explicit |
Constructor.
- Parameters
-
| [in] | report | Where to report errors. The report object must remain valid as long as this object exists or setReport() is used with another Report object. If report is null, log messages are discarded. |
| [in] | owner | Optional address of an "owner" object, typically an instance of class containing this object. |
◆ OpenSSLCertificate() [2/2]
| ts::OpenSSLCertificate::OpenSSLCertificate |
( |
ReporterBase * |
delegate, |
|
|
Object * |
owner = nullptr |
|
) |
| |
|
explicit |
Constructor.
- Parameters
-
| [in] | delegate | Use the report of another ReporterBase. If delegate is null, log messages are discarded. |
| [in] | owner | Optional address of an "owner" object, typically an instance of class containing this object. |
◆ getCertificate()
| SSL_CTX * ts::OpenSSLCertificate::getCertificate |
( |
| ) |
const |
|
inline |
Get the certificate context, for usage in OpenSSL.
- Returns
- The certificate context, or a null pointer if none is available.
◆ isValid()
| bool ts::OpenSSLCertificate::isValid |
( |
| ) |
const |
|
inline |
Check if a certificate is loaded and valid.
- Returns
- Trues if a certificate is loaded and valid, false otherwise.
◆ createEphemeralCertificate()
| bool ts::OpenSSLCertificate::createEphemeralCertificate |
( |
size_t |
rsa_bits | ) |
|
Create an ephemeral self-signed certificate.
The previous certificate, if any, is replaced.
- Parameters
-
| [in] | rsa_bits | Size in bits of the RSA key to create for the certificate. |
- Returns
- True on success, false on error.
◆ loadCertificate()
| bool ts::OpenSSLCertificate::loadCertificate |
( |
const UString & |
certificate_path, |
|
|
const UString & |
key_path |
|
) |
| |
Load a certificate from a store.
The previous certificate, if any, is replaced.
- Parameters
-
| [in] | certificate_path | Path name of the certificate file in PEM format. |
| [in] | key_path | Path name of the private key file in PEM format. |
- Returns
- True on success, false on error.
◆ initServerCertificate()
| bool ts::OpenSSLCertificate::initServerCertificate |
( |
const TLSServerBase & |
params | ) |
|
Initialize (get or create) a server certificate, if not already done.
If a certificate is already present, don't replace it.
- Parameters
-
| [in] | params | Server parameters. |
- Returns
- True on success, false on error.
◆ terminate()
| virtual void ts::OpenSSLCertificate::terminate |
( |
| ) |
|
|
overridevirtual |
This method terminates anything about OpenSSL which must be cleaned up.
This method must be idempotent and must be called in the subclass destructor.
Implements ts::OpenSSL::Controlled.
◆ report()
| Report & ts::ReporterBase::report |
( |
| ) |
const |
|
inherited |
Access the Report which is associated with this object.
Can be called from another thread only if the Report object is thread-safe.
- Returns
- A reference to the associated report.
◆ setReport() [1/2]
Associate this object with another Report to log errors.
- Parameters
-
| [in] | report | Where to report errors. The report object must remain valid as long as this object exists or setReport() is used with another Report object. If report is null, log messages are discarded. |
- Returns
- The address of the previous Report object or a null pointer if there was none.
◆ setReport() [2/2]
Associate this object with another ReporterBase to log errors.
- Parameters
-
| [in] | delegate | Use the report of another ReporterBase. If delegate is null, the previous explicit Report is used.. |
- Returns
- The address of the previous ReporterBase object or a null pointer if there was none.
◆ muteReport()
| bool ts::ReporterBase::muteReport |
( |
bool |
mute | ) |
|
|
inherited |
Temporarily mute the associated report.
- Parameters
-
| [in] | mute | It true, report() will return a null report (log messages are discarded), until muteReport() is invoked again with mute set to false. |
- Returns
- Previous state of the mute field.
◆ SilentLevel()
| static int ts::ReporterBase::SilentLevel |
( |
bool |
silent | ) |
|
|
inlinestaticinherited |
Compute a log severity level from a "silent" parameter.
Some subclass methods have a "silent" parameter to avoid reporting errors which may be insignificant, typically when closing a device after an error, in which case the close operation may produce other errors if the previous error left the device in an inconsistent state. While those errors should not be displayed as errors, we still display them at debug level.
- Parameters
-
| [in] | silent | If true, do not report errors, report debug messages instead. |
- Returns
- Error when silent is false, Debug otherwise.
◆ owner() [1/2]
| Object * ts::OwnedObject::owner |
( |
| ) |
|
|
inlineinherited |
Get the address of the optional "owner" object which was specified in the constructor.
- Returns
- Address of the "owner" object or a null pointer if there was none.
◆ owner() [2/2]
template<class OBJECT >
requires std::derived_from<OBJECT,
ts::Object>
| OBJECT * ts::OwnedObject::owner |
( |
| ) |
|
|
inherited |
Get the address of the "owner" object which was specified in the constructor.
This template version requires that the owner objet is set and of type OBJECT, or some subclass of it. If there is no owner object or if it is not compatible with the template class OBJECT, this is a fatal error and the application is terminated.
- Template Parameters
-
- Returns
- Address of the "owner" object or a null pointer if there was none.
◆ isOwned() [1/2]
| bool ts::OwnedObject::isOwned |
( |
| ) |
|
|
inlineinherited |
Check if the object is owned.
- Returns
- True if this object has an owner, false otherwise.
◆ isOwned() [2/2]
template<class OBJECT >
requires std::derived_from<OBJECT,
ts::Object>
| bool ts::OwnedObject::isOwned |
( |
| ) |
|
|
inlineinherited |
Check if the object is owned by an object of a given type.
- Template Parameters
-
- Returns
- True if this object has an owner by an object of type OBJECT, false otherwise.
The documentation for this class was generated from the following file:
1.9.8