SCEP interface. More...

import "Scep.idl";

Classes
struct	EnrollmentData
	Data needed for initial enrollment. More...

struct	EnrollmentRunInfo

struct	ScepSettings
	Settings for all SCEP enrollments (initial and renewal) More...

struct	ScepStatus
	The current status of SCEP. More...

struct	ScepStatusChangedEvent

Public Types
enum	EnrollmentRunStatus { NOT_RUN , STARTED , PENDING , SUCCESS , FAILED }

Public Member Functions
int	enableScep (in EnrollmentData initialEnrollmentData, in ScepSettings scepSettings)
	Enable SCEP.

void	discardScep ()
	Disable SCEP and discard all settings of this SCEP setup, allowing manual management of the TLS certificate again.

EnrollmentData	getInitialEnrollmentData ()
	Get the data that is used for the initial enrollment.

ScepSettings	getSettings ()
	Get the SCEP settings.

ScepStatus	getStatus ()
	Get the SCEP status.

int	setSettings (in ScepSettings scepSettings)
	Set SCEP settings of an existing SCEP setup.

vector< ServerSSLCert::KeyInfo >	getSupportedKeyInfos ()
	Get all supported key variants.

Public Attributes
constant int	NO_ERROR = 0

constant int	ERR_INVALID_PARAMS = 1

Detailed Description

SCEP interface.

Definition at line 15 of file Scep.idl.

Member Enumeration Documentation

◆ EnrollmentRunStatus

enum cert::Scep::EnrollmentRunStatus

Enumerator
NOT_RUN	Enrollment has not run yet.
STARTED	Enrollment run started.
PENDING	Enrollment run went to pending state.
SUCCESS	Enrollment run succeeded.
FAILED	Enrollment run failed.

Definition at line 37 of file Scep.idl.

Member Function Documentation

◆ discardScep()

void cert::Scep::discardScep ( )

Disable SCEP and discard all settings of this SCEP setup, allowing manual management of the TLS certificate again.

Re-enabling SCEP will start with the initial enrollment again.

◆ enableScep()

int cert::Scep::enableScep	(	in EnrollmentData	initialEnrollmentData,
		in ScepSettings	scepSettings )

Enable SCEP.

This will reset a previous SCEP setup and start with the initial enrollment again.

Parameters

initialEnrollmentData
scepSettings

Returns: NO_ERROR enabled SCEP successfully; ERR_INVALID_PARAMS one of the parameters was invalid

◆ getInitialEnrollmentData()

EnrollmentData cert::Scep::getInitialEnrollmentData ( )

Get the data that is used for the initial enrollment.

For Renewals, this is not used anymore.

Returns: initial enrollment data

◆ getSettings()

ScepSettings cert::Scep::getSettings ( )

Get the SCEP settings.

Returns: SCEP settings

◆ getStatus()

ScepStatus cert::Scep::getStatus ( )

Get the SCEP status.

Returns: SCEP status

◆ getSupportedKeyInfos()

vector< ServerSSLCert::KeyInfo > cert::Scep::getSupportedKeyInfos ( )

Get all supported key variants.

Returns: Vector of KeyInfo structures representing all supported key variants

◆ setSettings()

int cert::Scep::setSettings ( in ScepSettings scepSettings )

Set SCEP settings of an existing SCEP setup.

Note, that this will kill a currently running SCEP enrollment and immediately retry.

Returns: NO_ERROR changed ScepSettings successfully; ERR_INVALID_PARAMS one of the parameters was invalid

Member Data Documentation

◆ ERR_INVALID_PARAMS

constant int cert::Scep::ERR_INVALID_PARAMS = 1

Definition at line 18 of file Scep.idl.

◆ NO_ERROR

constant int cert::Scep::NO_ERROR = 0

Definition at line 17 of file Scep.idl.

The documentation for this interface was generated from the following file:

Scep.idl

Classes

Public Types

Public Member Functions

Public Attributes