AcmeClient

Overview

The AcmeClient allows to use Let's Encrypt service for generating of Let's Encrypt certificates

Location

  • Reference: RemObjects.SDK.Server.dll
  • Namespace: RemObjects.SDK.Server
  • Platforms: .NET Core, .NET Framework 4.8, .NET Standard 2.1
  • Ancestry: Component | AcmeClient

 

AccountEmails

AccountEmails are used for registering Let's Encrypt account.

 

var AccountEmails: array of String;

 

String[] AccountEmails

 

var AccountEmails: String...

 

FIELD AccountEmails() As String()

AccountPKFileName

Specifies file that contains private key for Let's Encrypt account.

 

var AccountPKFileName: String;

 

String AccountPKFileName

 

var AccountPKFileName: String

 

FIELD AccountPKFileName() As String

CertificateExpired

Returns date of certificate expiration.

 

var CertificateExpired: DateTime;

 

DateTime CertificateExpired

 

var CertificateExpired: DateTime

 

FIELD CertificateExpired() As DateTime

CertificateFileName

Specifies file that contains Let's Encrypt certificate in .pfx format

 

var CertificateFileName: String;

 

String CertificateFileName

 

var CertificateFileName: String

 

FIELD CertificateFileName() As String

CustomHTTP80Port

Can be used for customization of default http port in case of port forwarding on router is used.
If server has direct access to internet, 80 port has to used

 

var CustomHTTP80Port: Int32;

 

Int32 CustomHTTP80Port

 

var CustomHTTP80Port: Int32

 

FIELD CustomHTTP80Port() As Int32

Domains

Supported domains

 

var Domains: array of String;

 

String[] Domains

 

var Domains: String...

 

FIELD Domains() As String()

LoadConfig

Loads configuration from file

 

method LoadConfig(fileName: String := 'acme.config')

 

void LoadConfig(String fileName = \"acme.config\")

 

func LoadConfig(_ fileName: String = \"acme.config\")

 

Sub LoadConfig(fileName As String = \"acme.config\")

Parameters:

  • fileName: filename

NewOrder

Issues certificate from Lets' Encrypt service.

 

method NewOrder: Boolean

 

Boolean NewOrder()

 

func NewOrder() -> Boolean

 

Function NewOrder() As Boolean

OnGetPassword

Allows to specify password for certificate private key

 

event OnGetPassword: EventHandler<OnGetPasswordEventArgs>

 

delegate EventHandler<OnGetPasswordEventArgs> OnGetPassword()

 

__event EventHandler<OnGetPasswordEventArgs>: OnGetPassword!

 

Event OnGetPassword As EventHandler<OnGetPasswordEventArgs>

OrderStatusCode

Status of last operation

 

property OrderStatusCode: Int32 read;

 

Int32 OrderStatusCode { get; }

 

var OrderStatusCode: Int32 { get{} }

 

ReadOnly Property OrderStatusCode() As Int32

SaveConfig

Saves configuration to file

 

method SaveConfig(fileName: String := 'acme.config')

 

void SaveConfig(String fileName = \"acme.config\")

 

func SaveConfig(_ fileName: String = \"acme.config\")

 

Sub SaveConfig(fileName As String = \"acme.config\")

Parameters:

  • fileName: filename

Staging

Uses production or staging server.

 

var Staging: Boolean;

 

Boolean Staging

 

var Staging: Boolean

 

FIELD Staging() As Boolean

 

AccountEmails

AccountEmails are used for registering Let's Encrypt account.

 

var AccountEmails: array of String;

 

String[] AccountEmails

 

var AccountEmails: String...

 

FIELD AccountEmails() As String()

AccountPKFileName

Specifies file that contains private key for Let's Encrypt account.

 

var AccountPKFileName: String;

 

String AccountPKFileName

 

var AccountPKFileName: String

 

FIELD AccountPKFileName() As String

CertificateExpired

Returns date of certificate expiration.

 

var CertificateExpired: DateTime;

 

DateTime CertificateExpired

 

var CertificateExpired: DateTime

 

FIELD CertificateExpired() As DateTime

CertificateFileName

Specifies file that contains Let's Encrypt certificate in .pfx format

 

var CertificateFileName: String;

 

String CertificateFileName

 

var CertificateFileName: String

 

FIELD CertificateFileName() As String

CustomHTTP80Port

Can be used for customization of default http port in case of port forwarding on router is used.
If server has direct access to internet, 80 port has to used

 

var CustomHTTP80Port: Int32;

 

Int32 CustomHTTP80Port

 

var CustomHTTP80Port: Int32

 

FIELD CustomHTTP80Port() As Int32

Domains

Supported domains

 

var Domains: array of String;

 

String[] Domains

 

var Domains: String...

 

FIELD Domains() As String()

Staging

Uses production or staging server.

 

var Staging: Boolean;

 

Boolean Staging

 

var Staging: Boolean

 

FIELD Staging() As Boolean

 

OrderStatusCode

Status of last operation

 

property OrderStatusCode: Int32 read;

 

Int32 OrderStatusCode { get; }

 

var OrderStatusCode: Int32 { get{} }

 

ReadOnly Property OrderStatusCode() As Int32

 

LoadConfig

Loads configuration from file

 

method LoadConfig(fileName: String := 'acme.config')

 

void LoadConfig(String fileName = \"acme.config\")

 

func LoadConfig(_ fileName: String = \"acme.config\")

 

Sub LoadConfig(fileName As String = \"acme.config\")

Parameters:

  • fileName: filename

NewOrder

Issues certificate from Lets' Encrypt service.

 

method NewOrder: Boolean

 

Boolean NewOrder()

 

func NewOrder() -> Boolean

 

Function NewOrder() As Boolean

SaveConfig

Saves configuration to file

 

method SaveConfig(fileName: String := 'acme.config')

 

void SaveConfig(String fileName = \"acme.config\")

 

func SaveConfig(_ fileName: String = \"acme.config\")

 

Sub SaveConfig(fileName As String = \"acme.config\")

Parameters:

  • fileName: filename

 

OnGetPassword

Allows to specify password for certificate private key

 

event OnGetPassword: EventHandler<OnGetPasswordEventArgs>

 

delegate EventHandler<OnGetPasswordEventArgs> OnGetPassword()

 

__event EventHandler<OnGetPasswordEventArgs>: OnGetPassword!

 

Event OnGetPassword As EventHandler<OnGetPasswordEventArgs>