You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-61Lines changed: 28 additions & 61 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,13 +53,12 @@ The Axis IP Camera Orchestrator extension DOES NOT support the following use cas
53
53
54
54
\* Currently supported certificate usages include: **HTTPS**, **IEEE802.X**, **MQTT**, **Other**
55
55
56
-
57
-
58
56
## Compatibility
59
57
60
58
This integration is compatible with Keyfactor Universal Orchestrator version 10.1 and later.
61
59
62
60
## Support
61
+
63
62
The AXIS IP Camera Universal Orchestrator extension is supported by Keyfactor. If you require support for any issues or have feature request, please open a support ticket by either contacting your Keyfactor representative or via the Keyfactor Support Portal at https://support.keyfactor.com.
64
63
65
64
> If you want to contribute bug fixes or additional enhancements, use the **[Pull requests](../../pulls)** tab.
@@ -68,52 +67,44 @@ The AXIS IP Camera Universal Orchestrator extension is supported by Keyfactor. I
68
67
69
68
Before installing the AXIS IP Camera Universal Orchestrator extension, we recommend that you install [kfutil](https://github.com/Keyfactor/kfutil). Kfutil is a command-line tool that simplifies the process of creating store types, installing extensions, and instantiating certificate stores in Keyfactor Command.
70
69
71
-
72
70
1. Out of the box, an AXIS IP Network Camera will typically have configured an **Administrator** account. It is
73
71
recommended to create a new account specifically for executing API calls. This account will need \'Administrator\'
74
72
privileges since the orchestrator extension is capable of making configuration changes, such as installing and removing certificates.
75
73
2. Currently supports AXIS M2035-LE Bullet Camera, AXIS OS version 12.2.62. Has not been tested with any other firmware version.
76
74
77
-
78
75
## AxisIPCamera Certificate Store Type
79
76
80
77
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.
81
78
82
-
83
-
84
79
The AXIS IP Camera certificate store type represents a certificate store on an AXIS network camera
85
80
that maintains two separate collections of certificates:
86
81
* Client-server certificates (certs with private keys)
87
82
* CA certificates
88
83
89
84
It is expected that there be one (1) certificate store managed per AXIS network camera.
90
85
91
-
92
-
93
-
94
86
#### Axis IP Camera Requirements
95
87
96
88
1. User Account with \'Administrator\' privileges and password to access the camera
`kfutil` is a custom CLI for the Keyfactor Command API and can be used to create certificate store types.
116
106
For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out the [docs](https://github.com/Keyfactor/kfutil?tab=readme-ov-file#quickstart)
107
+
117
108
<details><summary>Click to expand AxisIPCamera kfutil details</summary>
118
109
119
110
##### Using online definition from GitHub:
@@ -132,10 +123,10 @@ For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out
132
123
```
133
124
</details>
134
125
135
-
136
126
#### Manual Creation
137
127
Below are instructions on how to create the AxisIPCamera store type manually in
138
128
the Keyfactor Command Portal
129
+
139
130
<details><summary>Click to expand manual AxisIPCamera details</summary>
140
131
141
132
Create a store type called `AxisIPCamera` with the attributes in the tables below:
@@ -146,11 +137,11 @@ the Keyfactor Command Portal
146
137
| Name | Axis IP Camera | Display name for the store type (may be customized) |
147
138
| Short Name | AxisIPCamera | Short display name for the store type |
148
139
| Capability | AxisIPCamera | Store type name orchestrator will register with. Check the box to allow entry of value |
149
-
| Supports Add | ✅ Checked |Check the box. Indicates that the Store Type supports Management Add |
150
-
| Supports Remove | ✅ Checked |Check the box. Indicates that the Store Type supports Management Remove |
151
-
| Supports Discovery | 🔲 Unchecked |Indicates that the Store Type supports Discovery |
152
-
| Supports Reenrollment | ✅ Checked |Indicates that the Store Type supports Reenrollment |
153
-
| Supports Create | 🔲 Unchecked |Indicates that the Store Type supports store creation |
140
+
| Supports Add | ✅ Checked | Indicates that the Store Type supports Management Add |
141
+
| Supports Remove | ✅ Checked | Indicates that the Store Type supports Management Remove |
142
+
| Supports Discovery | 🔲 Unchecked | Indicates that the Store Type supports Discovery |
143
+
| Supports Reenrollment | ✅ Checked | Indicates that the Store Type supports Reenrollment |
144
+
| Supports Create | 🔲 Unchecked | Indicates that the Store Type supports store creation |
154
145
| Needs Server | ✅ Checked | Determines if a target server name is required when creating store |
155
146
| Blueprint Allowed | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint |
156
147
| Uses PowerShell | 🔲 Unchecked | Determines if underlying implementation is PowerShell |
@@ -159,18 +150,18 @@ the Keyfactor Command Portal
| Supports Custom Alias | Required | Determines if an individual entry within a store can have a custom Alias. |
168
-
| 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. |
159
+
| Private Key Handling | Forbidden | This determines if Keyfactor can send the private key associated with a certificate to the store. |
169
160
| 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.) |
> 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.
@@ -243,12 +223,12 @@ the Keyfactor Command Portal
243
223
244
224
1.**Download the latest AXIS IP Camera Universal Orchestrator extension from GitHub.**
245
225
246
-
Navigate to the [AXIS IP Camera Universal Orchestrator extension GitHub version page](https://github.com/Keyfactor/axis-ipcamera-orchestrator/releases/latest). Refer to the compatibility matrix below to determine the asset should be downloaded. Then, click the corresponding asset to download the zip archive.
226
+
Navigate to the [AXIS IP Camera Universal Orchestrator extension GitHub version page](https://github.com/Keyfactor/axis-ipcamera-orchestrator/releases/latest). Refer to the compatibility matrix below to determine which asset should be downloaded. Then, click the corresponding asset to download the zip archive.
247
227
248
228
| Universal Orchestrator Version | Latest .NET version installed on the Universal Orchestrator server |`rollForward` condition in `Orchestrator.runtimeconfig.json`|`axis-ipcamera-orchestrator` .NET version to download |
| Between `11.0.0` and `11.5.1` (inclusive) |`net8.0`|`LatestMajor`|`net8.0`|
251
-
|`11.6`_and_ newer |`net8.0`||`net8.0`|
231
+
|`11.6`_and_ newer |`net8.0`||`net8.0`|
252
232
253
233
Unzip the archive containing extension assemblies to a known location.
254
234
@@ -270,17 +250,14 @@ the Keyfactor Command Portal
270
250
271
251
Refer to [Starting/Restarting the Universal Orchestrator service](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/StarttheService.htm).
272
252
273
-
274
253
6.**(optional) PAM Integration**
275
254
276
255
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.
277
256
278
257
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).
279
258
280
-
281
259
> 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).
282
260
283
-
284
261
## Post Installation
285
262
286
263
The AXIS IP Camera Orchestrator Extension *always* connects to an AXIS IP Network Camera via HTTPS, regardless
@@ -319,11 +296,8 @@ These values must match or the session will be denied.
319
296
> Therefore, you will need to install the full CA chain - including root and intermediate certificates - into the orchestrator server's local
320
297
> certificate store.
321
298
322
-
323
299
## Defining Certificate Stores
324
300
325
-
326
-
327
301
### Store Creation
328
302
329
303
#### Manually with the Command UI
@@ -338,8 +312,8 @@ These values must match or the session will be denied.
338
312
339
313
Click the Add button to add a new Certificate Store. Use the table below to populate the **Attributes** in the **Add** form.
| Category | Select "Axis IP Camera" or the customized certificate store name from the previous step. |
344
318
| Container | Optional container to associate certificate store with. |
345
319
| Client Machine | The IP address of the Camera. Sample is "192.167.231.174:44444". Include the port if necessary. |
@@ -351,8 +325,6 @@ These values must match or the session will be denied.
351
325
352
326
</details>
353
327
354
-
355
-
356
328
#### Using kfutil CLI
357
329
358
330
<details><summary>Click to expand details</summary>
@@ -385,7 +357,6 @@ These values must match or the session will be denied.
385
357
386
358
</details>
387
359
388
-
389
360
#### PAM Provider Eligible Fields
390
361
<details><summary>Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator</summary>
391
362
@@ -401,10 +372,8 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
401
372
402
373
</details>
403
374
404
-
405
375
> 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).
406
376
407
-
408
377
### Certificate Usage
409
378
410
379
Every certificate inventoried will have an Entry Parameter called \`Certificate Usage\`.
@@ -449,7 +418,6 @@ There are five (5) possible options:
449
418
> * DNS = CN set in the Subject DN
450
419
451
420
452
-
453
421
## Caveats
454
422
455
423
> [!NOTE]
@@ -459,11 +427,10 @@ There are five (5) possible options:
459
427
> If a new alias is supplied, a Reenrollment job will not remove the original certificate associated with the \`Certificate Usage\`.
460
428
> Since the camera has limited storage, it will be up to the user to remove any unused certificates via the AXIS Network Camera GUI.
461
429
462
-
463
430
## License
464
431
465
432
Apache License 2.0, see [LICENSE](LICENSE).
466
433
467
434
## Related Integrations
468
435
469
-
See all [Keyfactor Universal Orchestrator extensions](https://github.com/orgs/Keyfactor/repositories?q=orchestrator).
436
+
See all [Keyfactor Universal Orchestrator extensions](https://github.com/orgs/Keyfactor/repositories?q=orchestrator).
0 commit comments