Skip to content

Commit f51f97d

Browse files
committed
Updated README
1 parent 803ee9b commit f51f97d

2 files changed

Lines changed: 52 additions & 26 deletions

File tree

docsource/axisipcamera.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -36,22 +36,4 @@ There are five (5) possible options:
3636
4. Trust
3737
- This certificate usage describes a public certificate issued by a CA used to establish trust.
3838
5. Other
39-
- This certificate usage identifies all other certificates on the camera that do not fall under the pre-defined usages above.
40-
41-
> [!NOTE]
42-
> A Reenrollment (ODKG) job will not allow enrollment of certificates with **Trust** assigned as the \`Certificate Usage\`.
43-
> Trust CA certificates can be added to the camera via a Management - Add job.
44-
> These CA certificates establish trust for TLS connections initiated by the camera.
45-
46-
> [!NOTE]
47-
> As of Keyfactor Command v25.4, SANs can be provided for a Reenrollment (ODKG) job.
48-
> You must also have installed, at minimum, the Keyfactor Universal Orchestator v25.1
49-
> in order for the SANs to be sent to the orchestrator.
50-
>
51-
> The Axis IP Camera API *only* supports the addition of DNS and IP SANs. If you add other SAN types to the ODKG job, these will be ignored and not added to the certificate.
52-
>
53-
> * If SANs are NOT provided and the \`Certificate Usage\` assigned is **HTTPS**, IP and DNS will be automatically added as SANs to an enrolled certificate associated with a NEW alias.
54-
>
55-
> * IP = Client Machine configured for the certificate store (excluding any port)
56-
>
57-
> * DNS = CN set in the Subject DN
39+
- This certificate usage identifies all other certificates on the camera that do not fall under the pre-defined usages above.

docsource/content.md

Lines changed: 51 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,49 @@ The Axis IP Camera Orchestrator extension DOES NOT support the following use cas
2222

2323
\* Currently supported certificate usages include: **HTTPS**, **IEEE802.X**, **MQTT**, **Other**
2424

25+
## Enrollment Behavior
26+
27+
The following enrollment behaviors are specific to AXIS cameras and should be considered when designing certificate automation workflows.
28+
29+
### Alias Versioning
30+
31+
AXIS cameras require each Alias to be unique, and each Alias is tightly coupled with the private key used to generate its certificate. Because of this, certificates cannot be reenrolled in place by replacing the certificate and private key associated with an existing Alias.
32+
33+
To support certificate renewals and automation workflows, the orchestrator generates a unique Alias by appending the following suffix:
34+
35+
`_yyMMddHHmm`
36+
37+
where `yyMMddHHmm` represents the current UTC date and time.
38+
39+
From an automation perspective, the same Alias can continue to be reused, as uniqueness is enforced by the integration.
40+
41+
> [!NOTE]
42+
> As of v1.1.0, Reenrollment jobs automatically manage versioned Aliases. When reenrolling a certificate using the same Alias, the integration creates a new certificate using a versioned Alias and removes the previously enrolled certificate associated with the same base Alias.
43+
>
44+
> Because AXIS cameras do not support in-place certificate replacement, a new versioned Alias is still created during reenrollment. The integration identifies and removes the previous certificate by matching the base Alias name and ignoring the timestamp suffix.
45+
>
46+
> If a new Alias is supplied during reenrollment, the original certificate (if one exists) associated with the selected `Certificate Usage` is **not** automatically removed from the camera. Because AXIS cameras have limited certificate and key storage capacity, users should periodically review and remove unused certificates through the AXIS Network Camera GUI.
47+
48+
### Certificate Usage Considerations (Trust)
49+
50+
> [!NOTE]
51+
> If a Reenrollment (ODKG) job is configured with `Trust` selected as the `Certificate Usage`, the job will return a warning indicating that the operation is not supported.
52+
>
53+
> Trust CA certificates must be installed using a **Management - Add** job. These certificates establish trust for TLS connections initiated by the camera.
54+
55+
### Subject Alternative Names (SANs)
56+
57+
As of Keyfactor Command v25.4, Subject Alternative Names (SANs) can be specified for Reenrollment (ODKG) jobs. Support for passing SANs to the orchestrator also requires, at minimum, Keyfactor Universal Orchestrator v25.1.
58+
59+
The AXIS IP Camera API only supports DNS and IP SAN types. Any other SAN types included in the Reenrollment job will be ignored and will not be added to the enrolled certificate.
60+
61+
> [!NOTE]
62+
> If SANs are not provided and the selected `Certificate Usage` is `HTTPS`, IP and DNS SANs are automatically added when enrolling a certificate associated with a new Alias:
63+
>
64+
> - **IP** = The Client Machine configured for the certificate store (excluding any port number)
65+
> - **DNS** = The Common Name (CN) specified in the certificate Subject DN
66+
67+
2568
## Requirements
2669

2770
1. Out of the box, an AXIS IP Network Camera will typically have configured an **Administrator** account. It is
@@ -67,11 +110,12 @@ These values must match or the session will be denied.
67110
> Therefore, you will need to install the full CA chain - including root and intermediate certificates - into the orchestrator server's local
68111
> certificate store.
69112
70-
## Caveats
113+
## Operational Notes
71114

72-
> [!NOTE]
73-
> v1.1.0 - A Reenrollment job will now replace the certificate contents for an existing alias on the camera, therefore, not requiring
74-
> a new alias be supplied for every new certificate enrollment.
75-
>
76-
> If a new alias is supplied, a Reenrollment job will not remove the original certificate associated with the \`Certificate Usage\`.
77-
> Since the camera has limited storage, it will be up to the user to remove any unused certificates via the AXIS Network Camera GUI.
115+
### AXIS OS 12 Firmware Recommendation
116+
117+
> [!IMPORTANT]
118+
> Devices running the AXIS OS 12 release track should always be updated to the latest firmware version available from Axis. Previous firmware versions are no longer supported once a newer release becomes available.
119+
120+
Axis identified a memory leak in older firmware releases that may cause device keystore storage to become exhausted over time. If keystore storage issues are observed, verify that the device is running the latest supported firmware version.
121+

0 commit comments

Comments
 (0)