Skip to content

Commit b41b175

Browse files
author
Keyfactor
committed
Update generated docs
1 parent a13a625 commit b41b175

1 file changed

Lines changed: 51 additions & 14 deletions

File tree

README.md

Lines changed: 51 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -246,37 +246,39 @@ the Keyfactor Command Portal
246246

247247
## Post Installation
248248

249-
The AXIS IP Camera Orchestrator Extension *always* connects to an AXIS IP Network Camera using an HTTPS connection, regardless
250-
of whether the \`Use SSL\` option on the certificate store is set to **false**. This is to ensure the orchestrator connection
249+
The AXIS IP Camera Orchestrator Extension *always* connects to an AXIS IP Network Camera via HTTPS, regardless
250+
of whether the \`Use SSL\` option on the certificate store is set to **false** (*The \`Use SSL\` option cannot be removed). This ensures the orchestrator
251251
is connecting to a valid camera.
252252

253-
All network cameras come pre-loaded with device ID certificates, and one of these certificates is configured on the camera to be provided in the TLS handshake
254-
to the client.
253+
All network cameras come pre-loaded with one (1) or more device ID certificates, and one of these certificates is configured on the camera to be provided in the TLS handshake
254+
to the client during an HTTPS request.
255255

256-
On the initial HTTPS connection to the camera, the orchestrator extension will not trust the device ID certificate, and will therefore
257-
deny the session.
256+
The orchestrator will not trust the device ID certificate, and will therefore deny the session to the camera.
258257

259-
In order to trust the device ID certificate, you must provide the root and intermediate CA certificate from the AXIS PKI chain to a custom trust.
258+
To trust the device ID certificate, you must create a custom trust and add the root and intermediate CA certificates from the AXIS PKI chain to it.
260259

261260
### Steps to Create the Custom Trust:
262261

263-
1. Once the DLLs from GitHub are installed, create two (2) files in `C:\Program Files\Keyfactor\Keyfactor Orchestrator\extensions\[AXIS IP Camera extension folder naem]\Files` folder with the below names:
262+
1. Once the DLLs from GitHub are installed, create two (2) files in `..\[AXIS IP Camera orchestrator extension folder name]\Files` folder with the below names:
264263
* **Axis.Trust**
265264
* **Axis.Intermediate**
266265

267-
2. Copy and paste the PEM contents of the AXIS PKI Root for the device ID configured for HTTPS access into the **Axis.Root** file
268-
3. Copy and paste the PEM contents of the AXIS PKI Intermediate for the device ID configured for HTTPS access into the **Axis.Intermediate** file
266+
2. Copy and paste the PEM contents of the AXIS PKI root for the device ID cert configured for the HTTP server into the **Axis.Root** file
267+
3. Copy and paste the PEM contents of the AXIS PKI intermediate for the device ID configured for the HTTP server into the **Axis.Intermediate** file
269268

270269
\* AXIS Device ID CA certificates can be found here: https://www.axis.com/support/public-key-infrastructure-repository
271270

272271
After the device ID is verified against the custom trust, the \`Store Path\` value of the certificate store will be compared against the SERIALNUMBER Subject DN attribute of the device ID certificate.
273272
These values must match or the session will be denied.
274273

275274
> [!IMPORTANT]
276-
> As part of the device onboarding, it is expected that the operator schedule a reenrollment job and select "HTTPS" as the Certificate Usage so that a new CA-signed certificate is used for secure web access to the camera.
275+
> You will want to replace the device ID certificate bound to the HTTP server with a CA-signed certificate. To do this,
276+
> you will need to schedule a reenrollment job and select "HTTPS" as the Certificate Usage.
277277
278278
> [!IMPORTANT]
279-
> Make sure the PKI trust for certificates enrolled via ODKG is installed on the orchestrator server's local machine certificate store.
279+
> After associating a CA-signed certificate with the HTTP server, you need to make sure the orchestrator server trusts the HTTPS certificate.
280+
> Therefore, you will need to install the full CA chain - including root and intermediate certificates - into the orchestrator server's local
281+
> certificate store.
280282
281283

282284
## Defining Certificate Stores
@@ -366,13 +368,48 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
366368

367369
### Certificate Usage
368370

369-
PLACEHOLDER
371+
Every certificate inventoried will have an Entry Parameter called \`Certificate Usage\`.
372+
There are four (4) possible options:
373+
374+
* **HTTPS**
375+
* **IEEE802.X**
376+
* **MQTT**
377+
* **Trust**
378+
* **Other**
379+
380+
1. HTTPS
381+
- This certificate usage describes the certificate bound to the camera's HTTP web server for HTTPS communication (i.e. server certificate or SSL/TLS certificate).
382+
2. IEEE802.X
383+
- This certificate usage describes the client certificate to authenticate the camera to a server using EAP-TLS. This client certificate
384+
is presented to the 802.1x radius server for authentication.
385+
3. MQTT
386+
- This certificate usage describes the client certificate used to authenticate the camera to the MQTT broker.
387+
In this scenario, the camera connects to the MQTT broker over SSL and performs a TLS handshake. If a client certificate is provided,
388+
the camera presents this client certificate to the MQTT broker.
389+
4. Trust
390+
- This certificate usage describes a public certificate issued by a CA used to establish trust.
391+
5. Other
392+
- This certificate usage identifies all other certificates on the camera that do not fall under the pre-defined usages above.
393+
394+
> [!NOTE]
395+
> A Reenrollment (ODKG) job will not allow enrollment of certificates with **Trust** assigned as the \`Certificate Usage\`.
396+
> Trust CA certificates can be added to the camera via a Management - Add job.
397+
398+
> [!NOTE]
399+
> For a Reenrollment (ODKG) job, where the \`Certificate Usage\` assigned is **HTTPS**, IP and DNS are added as SANS
400+
> to the enrolled certificate.
401+
>
402+
> IP = Client Machine configured for the certificate store (excluding any port)
403+
>
404+
> DNS = CN set in the Subject DN
370405
371406
372407
373408
## Caveats
374409
375-
PLACEHOLDER
410+
> [!CAVEAT] Reenrollment jobs will not replace or remove a client-server certificate with the same alias. They will also not remove
411+
> the original certificate if a particular \`Certificate Usage\` had an associated cert. Since the camera has limited storage,
412+
> it will be up to the user to remove any unused client-server certificates via the AXIS Network Camera GUI.
376413
377414
378415
## License

0 commit comments

Comments
 (0)