Local Signing Requester (signingService-LocalSigningRequester)
This component is a client to the Local Signing Transport and provides a parent component with the ability to make requests
to onboard/renew with a Signing Service running in the same station.
It is not possible to drop an instance of the Local Signing Requester onto any arbitrary component as code is required to support the interaction between the component and the requester. For more information, see “Installing a Signing Requester”.
| Property | Value | Description |
|---|---|---|
| Status | read-only | Displays the status of the requester component. It indicates if in alarm state when onboard/renew has failed. |
| Fault Cause | read-only | Displays the most recent fault message. |
| Enabled | true or false (defaults to true)
|
If false, actions are disabled.
|
| Requester State | read-only | Displays one of the following states: Not Onboarded, Approval In Progress, CSR Submitted, Renewal CSR Submitted, Renewal Failed, Onboarded |
| Advance Renewal Percentage | read-only | Displays the percent of the signed certificates validity period in which a renewal will be automatically attempted. With a 100–day certificate and a value of 10%, renewal will be first tried with 10 days remaining. |
| Advance Renewal | read-only | Displays the period prior to certificate expiry in which a renewal will be attempted. |
| Retry Period | read-only | Displays the delay between automatic attempts to renew. |
| Last Attempt | read-only | Reports the last time an onboard/renew was attempted. |
| Last Success | read-only | Reports the last time a certificate was successfully retrieved. |
| Last Failure | read-only | Reports the last time a request failed. |
| Next Renewal Attempt | read-only | Reports the last time at which a renewal will next be attempted. |
| Alarm on Failure to Onboard | True or false (defaults to false)
|
If true, an alarm is generated when an onboard attempt fails.
|
| Alarm on Failure to Renew | True or false (defaults to true)
|
If true, an alarm is generated when a renewal attempt fails.
|
| Alarm Source Info | additional properties | Provides configuration for alarms. |
| Requester Id | read-only | Displays the unique Id for this requester as registered with the Signing Service. It is automatically populated. |
Actions
Onboard: Registers this component with the Signing Service against the selected Profile. The component will automatically check for approval and perform the CSR submission and retrieval.
Renew: Forces a certificate renewal attempt.