Skip to content

Commit e7e9d6c

Browse files
author
Elena Fiocca
committed
Merge branch 'ab#69246_rebase' of github.com:Keyfactor/axis-ipcamera-orchestrator into ab#69246_rebase
2 parents 569c192 + fe49124 commit e7e9d6c

File tree

2 files changed

+77
-47
lines changed

2 files changed

+77
-47
lines changed

README.md

Lines changed: 77 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<p align="center">
66
<!-- Badges -->
7-
<img src="https://img.shields.io/badge/integration_status-prototype-3D1973?style=flat-square" alt="Integration Status: prototype" />
7+
<img src="https://img.shields.io/badge/integration_status-pilot-3D1973?style=flat-square" alt="Integration Status: pilot" />
88
<a href="https://github.com/Keyfactor/axis-ipcamera-orchestrator/releases"><img src="https://img.shields.io/github/v/release/Keyfactor/axis-ipcamera-orchestrator?style=flat-square" alt="Release" /></a>
99
<img src="https://img.shields.io/github/issues/Keyfactor/axis-ipcamera-orchestrator?style=flat-square" alt="Issues" />
1010
<img src="https://img.shields.io/github/downloads/Keyfactor/axis-ipcamera-orchestrator/total?style=flat-square&label=downloads&color=28B905" alt="GitHub Downloads (all assets, all releases)" />
@@ -52,9 +52,9 @@ Before installing the AXIS IP Camera Universal Orchestrator extension, we recomm
5252
TODO Requirements is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
5353

5454

55-
## MOST Certificate Store Type
55+
## AxisIPCamera Certificate Store Type
5656

57-
To use the AXIS IP Camera Universal Orchestrator extension, you **must** create the MOST Certificate Store Type. This only needs to happen _once_ per Keyfactor Command instance.
57+
To use the AXIS IP Camera Universal Orchestrator extension, you **must** create the AxisIPCamera Certificate Store Type. This only needs to happen _once_ per Keyfactor Command instance.
5858

5959

6060

@@ -65,7 +65,7 @@ TODO Global Store Type Section is an optional section. If this section doesn't s
6565

6666

6767

68-
#### MyOrchestratorStoreType Requirements
68+
#### Axis IP Camera Requirements
6969

7070
TODO Requirements is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
7171

@@ -75,24 +75,24 @@ TODO Requirements is an optional section. If this section doesn't seem necessary
7575

7676
| Operation | Is Supported |
7777
|--------------|------------------------------------------------------------------------------------------------------------------------|
78-
| Add | 🔲 Unchecked |
79-
| Remove | 🔲 Unchecked |
80-
| Discovery | ✅ Checked |
81-
| Reenrollment | 🔲 Unchecked |
78+
| Add | ✅ Checked |
79+
| Remove | ✅ Checked |
80+
| Discovery | 🔲 Unchecked |
81+
| Reenrollment | ✅ Checked |
8282
| Create | 🔲 Unchecked |
8383

8484
#### Store Type Creation
8585

8686
##### Using kfutil:
8787
`kfutil` is a custom CLI for the Keyfactor Command API and can be used to create certificate store types.
8888
For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out the [docs](https://github.com/Keyfactor/kfutil?tab=readme-ov-file#quickstart)
89-
<details><summary>Click to expand MOST kfutil details</summary>
89+
<details><summary>Click to expand AxisIPCamera kfutil details</summary>
9090

9191
##### Using online definition from GitHub:
9292
This will reach out to GitHub and pull the latest store-type definition
9393
```shell
94-
# MyOrchestratorStoreType
95-
kfutil store-types create MOST
94+
# Axis IP Camera
95+
kfutil store-types create AxisIPCamera
9696
```
9797

9898
##### Offline creation using integration-manifest file:
@@ -106,22 +106,22 @@ For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out
106106

107107

108108
#### Manual Creation
109-
Below are instructions on how to create the MOST store type manually in
109+
Below are instructions on how to create the AxisIPCamera store type manually in
110110
the Keyfactor Command Portal
111-
<details><summary>Click to expand manual MOST details</summary>
111+
<details><summary>Click to expand manual AxisIPCamera details</summary>
112112

113-
Create a store type called `MOST` with the attributes in the tables below:
113+
Create a store type called `AxisIPCamera` with the attributes in the tables below:
114114

115115
##### Basic Tab
116116
| Attribute | Value | Description |
117117
| --------- | ----- | ----- |
118-
| Name | MyOrchestratorStoreType | Display name for the store type (may be customized) |
119-
| Short Name | MOST | Short display name for the store type |
120-
| Capability | MOST | Store type name orchestrator will register with. Check the box to allow entry of value |
121-
| Supports Add | 🔲 Unchecked | Indicates that the Store Type supports Management Add |
122-
| Supports Remove | 🔲 Unchecked | Indicates that the Store Type supports Management Remove |
123-
| Supports Discovery | ✅ Checked | Check the box. Indicates that the Store Type supports Discovery |
124-
| Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment |
118+
| Name | Axis IP Camera | Display name for the store type (may be customized) |
119+
| Short Name | AxisIPCamera | Short display name for the store type |
120+
| Capability | AxisIPCamera | Store type name orchestrator will register with. Check the box to allow entry of value |
121+
| Supports Add | ✅ Checked | Check the box. Indicates that the Store Type supports Management Add |
122+
| Supports Remove | ✅ Checked | Check the box. Indicates that the Store Type supports Management Remove |
123+
| Supports Discovery | 🔲 Unchecked | Indicates that the Store Type supports Discovery |
124+
| Supports Reenrollment | ✅ Checked | Indicates that the Store Type supports Reenrollment |
125125
| Supports Create | 🔲 Unchecked | Indicates that the Store Type supports store creation |
126126
| Needs Server | ✅ Checked | Determines if a target server name is required when creating store |
127127
| Blueprint Allowed | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint |
@@ -131,18 +131,18 @@ the Keyfactor Command Portal
131131

132132
The Basic tab should look like this:
133133

134-
![MOST Basic Tab](docsource/images/MOST-basic-store-type-dialog.png)
134+
![AxisIPCamera Basic Tab](docsource/images/AxisIPCamera-basic-store-type-dialog.png)
135135

136136
##### Advanced Tab
137137
| Attribute | Value | Description |
138138
| --------- | ----- | ----- |
139-
| Supports Custom Alias | Forbidden | Determines if an individual entry within a store can have a custom Alias. |
139+
| Supports Custom Alias | Required | Determines if an individual entry within a store can have a custom Alias. |
140140
| Private Key Handling | Forbidden | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. |
141141
| PFX Password Style | Default | 'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.) |
142142

143143
The Advanced tab should look like this:
144144

145-
![MOST Advanced Tab](docsource/images/MOST-advanced-store-type-dialog.png)
145+
![AxisIPCamera Advanced Tab](docsource/images/AxisIPCamera-advanced-store-type-dialog.png)
146146

147147
> For Keyfactor **Command versions 24.4 and later**, a Certificate Format dropdown is available with PFX and PEM options. Ensure that **PFX** is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX.
148148
@@ -151,12 +151,23 @@ the Keyfactor Command Portal
151151

152152
| Name | Display Name | Description | Type | Default Value/Options | Required |
153153
| ---- | ------------ | ---- | --------------------- | -------- | ----------- |
154-
| CustomField1 | CustomField1 | | String | default | ✅ Checked |
155-
| CustomField2 | CustomField2 | | String | None | ✅ Checked |
154+
| ServerUsername | Server Username | Enter the username of the configured "service" user on the camera | Secret | | 🔲 Unchecked |
155+
| ServerPassword | Server Password | Enter the password of the configured "service" user on the camera | Secret | | 🔲 Unchecked |
156+
| ServerUseSsl | Use SSL | Select True or False depending on if SSL (HTTPS) should be used to communicate with the camera. This should always be "True" | Bool | true | ✅ Checked |
156157

157158
The Custom Fields tab should look like this:
158159

159-
![MOST Custom Fields Tab](docsource/images/MOST-custom-fields-store-type-dialog.png)
160+
![AxisIPCamera Custom Fields Tab](docsource/images/AxisIPCamera-custom-fields-store-type-dialog.png)
161+
162+
##### Entry Parameters Tab
163+
164+
| Name | Display Name | Description | Type | Default Value | Entry has a private key | Adding an entry | Removing an entry | Reenrolling an entry |
165+
| ---- | ------------ | ---- | ------------- | ----------------------- | ---------------- | ----------------- | ------------------- | ----------- |
166+
| CertUsage | Certificate Usage | The Certificate Usage to assign to the cert after enrollment. Can be left 'Other' to be assigned later. | MultipleChoice | | 🔲 Unchecked | ✅ Checked | 🔲 Unchecked | ✅ Checked |
167+
168+
The Entry Parameters tab should look like this:
169+
170+
![AxisIPCamera Entry Parameters Tab](docsource/images/AxisIPCamera-entry-parameters-store-type-dialog.png)
160171

161172
</details>
162173

@@ -195,6 +206,12 @@ the Keyfactor Command Portal
195206
Refer to [Starting/Restarting the Universal Orchestrator service](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/StarttheService.htm).
196207

197208

209+
6. **(optional) PAM Integration**
210+
211+
The AXIS IP Camera Universal Orchestrator extension is compatible with all supported Keyfactor PAM extensions to resolve PAM-eligible secrets. PAM extensions running on Universal Orchestrators enable secure retrieval of secrets from a connected PAM provider.
212+
213+
To configure a PAM provider, [reference the Keyfactor Integration Catalog](https://keyfactor.github.io/integrations-catalog/content/pam) to select an extension and follow the associated instructions to install it on the Universal Orchestrator (remote).
214+
198215

199216
> The above installation steps can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/CustomExtensions.htm?Highlight=extensions).
200217
@@ -228,13 +245,14 @@ TODO Certificate Store Configuration is an optional section. If this section doe
228245

229246
| Attribute | Description |
230247
| --------- |---------------------------------------------------------|
231-
| Category | Select "MyOrchestratorStoreType" or the customized certificate store name from the previous step. |
248+
| Category | Select "Axis IP Camera" or the customized certificate store name from the previous step. |
232249
| Container | Optional container to associate certificate store with. |
233-
| Client Machine | |
234-
| Store Path | |
235-
| Orchestrator | Select an approved orchestrator capable of managing `MOST` certificates. Specifically, one with the `MOST` capability. |
236-
| CustomField1 | |
237-
| CustomField2 | |
250+
| Client Machine | The IP address of the Camera. Sample is "192.167.231.174:44444". Include the port if necessary. |
251+
| Store Path | Enter the Serial Number of the camera e.g. `0b7c3d2f9e8a` |
252+
| Orchestrator | Select an approved orchestrator capable of managing `AxisIPCamera` certificates. Specifically, one with the `AxisIPCamera` capability. |
253+
| ServerUsername | Enter the username of the configured "service" user on the camera |
254+
| ServerPassword | Enter the password of the configured "service" user on the camera |
255+
| ServerUseSsl | Select True or False depending on if SSL (HTTPS) should be used to communicate with the camera. This should always be "True" |
238256

239257
</details>
240258

@@ -244,34 +262,50 @@ TODO Certificate Store Configuration is an optional section. If this section doe
244262

245263
<details><summary>Click to expand details</summary>
246264

247-
1. **Generate a CSV template for the MOST certificate store**
265+
1. **Generate a CSV template for the AxisIPCamera certificate store**
248266

249267
```shell
250-
kfutil stores import generate-template --store-type-name MOST --outpath MOST.csv
268+
kfutil stores import generate-template --store-type-name AxisIPCamera --outpath AxisIPCamera.csv
251269
```
252270
2. **Populate the generated CSV file**
253271

254272
Open the CSV file, and reference the table below to populate parameters for each **Attribute**.
255273

256274
| Attribute | Description |
257275
| --------- | ----------- |
258-
| Category | Select "MyOrchestratorStoreType" or the customized certificate store name from the previous step. |
276+
| Category | Select "Axis IP Camera" or the customized certificate store name from the previous step. |
259277
| Container | Optional container to associate certificate store with. |
260-
| Client Machine | |
261-
| Store Path | |
262-
| Orchestrator | Select an approved orchestrator capable of managing `MOST` certificates. Specifically, one with the `MOST` capability. |
263-
| Properties.CustomField1 | |
264-
| Properties.CustomField2 | |
278+
| Client Machine | The IP address of the Camera. Sample is "192.167.231.174:44444". Include the port if necessary. |
279+
| Store Path | Enter the Serial Number of the camera e.g. `0b7c3d2f9e8a` |
280+
| Orchestrator | Select an approved orchestrator capable of managing `AxisIPCamera` certificates. Specifically, one with the `AxisIPCamera` capability. |
281+
| Properties.ServerUsername | Enter the username of the configured "service" user on the camera |
282+
| Properties.ServerPassword | Enter the password of the configured "service" user on the camera |
283+
| Properties.ServerUseSsl | Select True or False depending on if SSL (HTTPS) should be used to communicate with the camera. This should always be "True" |
265284

266285
3. **Import the CSV file to create the certificate stores**
267286

268287
```shell
269-
kfutil stores import csv --store-type-name MOST --file MOST.csv
288+
kfutil stores import csv --store-type-name AxisIPCamera --file AxisIPCamera.csv
270289
```
271290

272291
</details>
273292

274293

294+
#### PAM Provider Eligible Fields
295+
<details><summary>Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator</summary>
296+
297+
If a PAM provider was installed _on the Universal Orchestrator_ in the [Installation](#Installation) section, the following parameters can be configured for retrieval _on the Universal Orchestrator_.
298+
299+
| Attribute | Description |
300+
| --------- | ----------- |
301+
| ServerUsername | Enter the username of the configured "service" user on the camera |
302+
| ServerPassword | Enter the password of the configured "service" user on the camera |
303+
304+
Please refer to the **Universal Orchestrator (remote)** usage section ([PAM providers on the Keyfactor Integration Catalog](https://keyfactor.github.io/integrations-catalog/content/pam)) for your selected PAM provider for instructions on how to load attributes orchestrator-side.
305+
> Any secret can be rendered by a PAM provider _installed on the Keyfactor Command server_. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.
306+
307+
</details>
308+
275309

276310
> The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
277311

@@ -280,7 +314,7 @@ TODO Certificate Store Configuration is an optional section. If this section doe
280314
TODO Discovery is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
281315
282316
283-
### MyOrchestratorStoreType Discovery Job
317+
### Axis IP Camera Discovery Job
284318
TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
285319

286320

docsource/axisipcamera.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,3 @@ It is expected that there be one (1) certificate store managed per Axis network
1313
2. Camera serial number
1414
3. Camera IP address (and likely port number)
1515

16-
## Global Store Type Section
17-
18-
TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
19-

0 commit comments

Comments
 (0)