Encapsulate a SChannel certificate (Windows-specific). More...

#include <tsSChannelCertificate.h>

Inheritance diagram for ts::SChannelCertificate:

[legend]

Collaboration diagram for ts::SChannelCertificate:

[legend]

Public Member Functions
	SChannelCertificate (Report report, Object owner=nullptr)
	Constructor.

	SChannelCertificate (ReporterBase delegate, Object owner=nullptr)
	Constructor.

virtual	~SChannelCertificate () override
	Destructor.

bool	createEphemeralCertificate (size_t rsa_bits)
	Create an ephemeral self-signed certificate.

::PCCERT_CONTEXT	getCertificate () const
	Get the certificate context, for usage in SChannel.

bool	initServerCertificate (const TLSServerBase &params)
	Initialize (get or create) a server certificate, if not already done.

bool	isOwned ()
	Check if the object is owned.

template<class OBJECT > requires std::derived_from<OBJECT, ts::Object>
bool	isOwned ()
	Check if the object is owned by an object of a given type.

bool	isValid () const
	Check if a certificate is loaded and valid.

bool	loadCertificate (const UString &store_name, const UString &cert_name)
	Load a certificate from a store.

bool	muteReport (bool mute)
	Temporarily mute the associated report.

Object *	owner ()
	Get the address of the optional "owner" object which was specified in the constructor.

template<class OBJECT > requires std::derived_from<OBJECT, ts::Object>
OBJECT *	owner ()
	Get the address of the "owner" object which was specified in the constructor.

Report &	report () const
	Access the Report which is associated with this object.

void	reset ()
	Reset the content of the certificate.

Report *	setReport (Report *report)
	Associate this object with another Report to log errors.

ReporterBase *	setReport (ReporterBase *delegate)
	Associate this object with another ReporterBase to log errors.

Static Public Member Functions
static UString	GetCertificateName (::PCCERT_CONTEXT cert, ::DWORD type)
	Get the name of a certificate name for a given type.

static int	SilentLevel (bool silent)
	Compute a log severity level from a "silent" parameter.

Detailed Description

Encapsulate a SChannel certificate (Windows-specific).

Constructor & Destructor Documentation

◆ SChannelCertificate() [1/2]

ts::SChannelCertificate::SChannelCertificate	(	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.

◆ SChannelCertificate() [2/2]

ts::SChannelCertificate::SChannelCertificate	(	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.

Member Function Documentation

◆ getCertificate()

::PCCERT_CONTEXT ts::SChannelCertificate::getCertificate ( ) const

inline

Get the certificate context, for usage in SChannel.

Returns: The certificate context, or a null pointer if none is available.

◆ isValid()

bool ts::SChannelCertificate::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::SChannelCertificate::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::SChannelCertificate::loadCertificate	(	const UString &	store_name,
		const UString &	cert_name
	)

Load a certificate from a store.

The previous certificate, if any, is replaced.

Parameters

[in]	store_name	Name of certificate store. One of "system", "user".
[in]	cert_name	Name of the certificate (friendly name or subject name or DNS name).

Returns: True on success, false on error.

◆ initServerCertificate()

bool ts::SChannelCertificate::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.

◆ GetCertificateName()

static UString ts::SChannelCertificate::GetCertificateName	(	::PCCERT_CONTEXT	cert,
		::DWORD	type
	)

static

Get the name of a certificate name for a given type.

Parameters

[in]	cert	Certificate handle.
[in]	type	Type of name (CERT_NAME_FRIENDLY_DISPLAY_TYPE, CERT_NAME_xxx).

Returns: Certificate name, empty string on error.

◆ 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]

Report * ts::ReporterBase::setReport ( Report * report )

inherited

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]

ReporterBase * ts::ReporterBase::setReport ( ReporterBase * delegate )

inherited

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

OBJECT A subclass of Object

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

OBJECT A subclass of Object

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:

tsSChannelCertificate.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SChannelCertificate() [1/2]

◆ SChannelCertificate() [2/2]

Member Function Documentation

◆ getCertificate()

◆ isValid()

◆ createEphemeralCertificate()

◆ loadCertificate()

◆ initServerCertificate()

◆ GetCertificateName()

◆ report()

◆ setReport() [1/2]

◆ setReport() [2/2]

◆ muteReport()

◆ SilentLevel()

◆ owner() [1/2]

◆ owner() [2/2]

◆ isOwned() [1/2]

◆ isOwned() [2/2]