Skip to content

Commit 02f3f26

Browse files
author
Keyfactor
committed
Update generated docs
1 parent c0feeeb commit 02f3f26

18 files changed

+184
-12
lines changed

README.md

Lines changed: 184 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,57 @@ the Keyfactor Command Portal
280280

281281
![WinCert Custom Fields Tab](docsource/images/WinCert-custom-fields-store-type-dialog.png)
282282

283+
284+
###### SPN With Port
285+
Internally set the -IncludePortInSPN option when creating the remote PowerShell connection. Needed for some Kerberos configurations.
286+
287+
![WinCert Custom Field - spnwithport](docsource/images/WinCert-custom-field-spnwithport-dialog.png)
288+
289+
290+
291+
###### WinRM Protocol
292+
Multiple choice value specifying which protocol to use. Protocols https or http use WinRM to connect from Windows to Windows Servers. Using ssh is only supported when running the orchestrator in a Linux environment.
293+
294+
![WinCert Custom Field - WinRM Protocol](docsource/images/WinCert-custom-field-WinRM Protocol-dialog.png)
295+
296+
297+
298+
###### WinRM Port
299+
String value specifying the port number that the Windows target server's WinRM listener is configured to use. Example: '5986' for HTTPS or '5985' for HTTP. By default, when using ssh in a Linux environment, the default port number is 22.
300+
301+
![WinCert Custom Field - WinRM Port](docsource/images/WinCert-custom-field-WinRM Port-dialog.png)
302+
303+
304+
305+
###### Server Username
306+
Username used to log into the target server for establishing the WinRM session. Example: 'administrator' or 'domain\username'.
307+
308+
309+
> [!IMPORTANT]
310+
> This field is created by the `Needs Server` on the Basic tab, do not create this field manually.
311+
312+
313+
314+
315+
###### Server Password
316+
Password corresponding to the Server Username used to log into the target server. When establishing a SSH session from a Linux environment, the password must include the full SSH Private key.
317+
318+
319+
> [!IMPORTANT]
320+
> This field is created by the `Needs Server` on the Basic tab, do not create this field manually.
321+
322+
323+
324+
325+
###### Use SSL
326+
Determine whether the server uses SSL or not (This field is automatically created)
327+
328+
![WinCert Custom Field - ServerUseSsl](docsource/images/WinCert-custom-field-ServerUseSsl-dialog.png)
329+
330+
331+
332+
333+
283334
##### Entry Parameters Tab
284335

285336
| Name | Display Name | Description | Type | Default Value | Entry has a private key | Adding an entry | Removing an entry | Reenrolling an entry |
@@ -292,12 +343,14 @@ the Keyfactor Command Portal
292343
![WinCert Entry Parameters Tab](docsource/images/WinCert-entry-parameters-store-type-dialog.png)
293344

294345

295-
##### ProviderName
346+
##### Crypto Provider Name
347+
Name of the Windows cryptographic service provider to use when generating and storing private keys. For more information, refer to the section 'Using Crypto Service Providers'
296348

297349
![WinCert Entry Parameter - ProviderName](docsource/images/WinCert-entry-parameters-store-type-dialog-ProviderName.png)
298350

299351

300352
##### SAN
353+
String value specifying the Subject Alternative Name (SAN) to be used when performing reenrollment jobs. Format as a list of <san_type>=<san_value> entries separated by ampersands; Example: 'dns=www.example.com&dns=www.example2.com' for multiple SANs. Can be made optional if RFC 2818 is disabled on the CA.
301354

302355
![WinCert Entry Parameter - SAN](docsource/images/WinCert-entry-parameters-store-type-dialog-SAN.png)
303356

@@ -421,6 +474,57 @@ the Keyfactor Command Portal
421474

422475
![IISU Custom Fields Tab](docsource/images/IISU-custom-fields-store-type-dialog.png)
423476

477+
478+
###### SPN With Port
479+
Internally set the -IncludePortInSPN option when creating the remote PowerShell connection. Needed for some Kerberos configurations.
480+
481+
![IISU Custom Field - spnwithport](docsource/images/IISU-custom-field-spnwithport-dialog.png)
482+
483+
484+
485+
###### WinRM Protocol
486+
Multiple choice value specifying which protocol to use. Protocols https or http use WinRM to connect from Windows to Windows Servers. Using ssh is only supported when running the orchestrator in a Linux environment.
487+
488+
![IISU Custom Field - WinRM Protocol](docsource/images/IISU-custom-field-WinRM Protocol-dialog.png)
489+
490+
491+
492+
###### WinRM Port
493+
String value specifying the port number that the Windows target server's WinRM listener is configured to use. Example: '5986' for HTTPS or '5985' for HTTP. By default, when using ssh in a Linux environment, the default port number is 22.
494+
495+
![IISU Custom Field - WinRM Port](docsource/images/IISU-custom-field-WinRM Port-dialog.png)
496+
497+
498+
499+
###### Server Username
500+
Username used to log into the target server for establishing the WinRM session. Example: 'administrator' or 'domain\username'.
501+
502+
503+
> [!IMPORTANT]
504+
> This field is created by the `Needs Server` on the Basic tab, do not create this field manually.
505+
506+
507+
508+
509+
###### Server Password
510+
Password corresponding to the Server Username used to log into the target server. When establishing a SSH session from a Linux environment, the password must include the full SSH Private key.
511+
512+
513+
> [!IMPORTANT]
514+
> This field is created by the `Needs Server` on the Basic tab, do not create this field manually.
515+
516+
517+
518+
519+
###### Use SSL
520+
Determine whether the server uses SSL or not (This field is automatically created)
521+
522+
![IISU Custom Field - ServerUseSsl](docsource/images/IISU-custom-field-ServerUseSsl-dialog.png)
523+
524+
525+
526+
527+
424528
##### Entry Parameters Tab
425529

426530
| Name | Display Name | Description | Type | Default Value | Entry has a private key | Adding an entry | Removing an entry | Reenrolling an entry |
@@ -440,41 +544,49 @@ the Keyfactor Command Portal
440544

441545

442546
##### Port
547+
String value specifying the IP port to bind the certificate to for the IIS site. Example: '443' for HTTPS.
443548

444549
![IISU Entry Parameter - Port](docsource/images/IISU-entry-parameters-store-type-dialog-Port.png)
445550

446551

447-
##### IPAddress
552+
##### IP Address
553+
String value specifying the IP address to bind the certificate to for the IIS site. Example: '*' for all IP addresses or '192.168.1.1' for a specific IP address.
448554

449555
![IISU Entry Parameter - IPAddress](docsource/images/IISU-entry-parameters-store-type-dialog-IPAddress.png)
450556

451557

452-
##### HostName
558+
##### Host Name
559+
String value specifying the host name (host header) to bind the certificate to for the IIS site. Leave blank for all host names or enter a specific hostname such as 'www.example.com'.
453560

454561
![IISU Entry Parameter - HostName](docsource/images/IISU-entry-parameters-store-type-dialog-HostName.png)
455562

456563

457-
##### SiteName
564+
##### IIS Site Name
565+
String value specifying the name of the IIS web site to bind the certificate to. Example: 'Default Web Site' or any custom site name such as 'MyWebsite'.
458566

459567
![IISU Entry Parameter - SiteName](docsource/images/IISU-entry-parameters-store-type-dialog-SiteName.png)
460568

461569

462-
##### SniFlag
570+
##### SSL Flags
571+
A 128-Bit Flag that determines what type of SSL settings you wish to use. The default is 0, meaning No SNI. For more information, check IIS documentation for the appropriate bit setting.)
463572

464573
![IISU Entry Parameter - SniFlag](docsource/images/IISU-entry-parameters-store-type-dialog-SniFlag.png)
465574

466575

467576
##### Protocol
577+
Multiple choice value specifying the protocol to bind to. Example: 'https' for secure communication.
468578

469579
![IISU Entry Parameter - Protocol](docsource/images/IISU-entry-parameters-store-type-dialog-Protocol.png)
470580

471581

472-
##### ProviderName
582+
##### Crypto Provider Name
583+
Name of the Windows cryptographic service provider to use when generating and storing private keys. For more information, refer to the section 'Using Crypto Service Providers'
473584

474585
![IISU Entry Parameter - ProviderName](docsource/images/IISU-entry-parameters-store-type-dialog-ProviderName.png)
475586

476587

477588
##### SAN
589+
String value specifying the Subject Alternative Name (SAN) to be used when performing reenrollment jobs. Format as a list of <san_type>=<san_value> entries separated by ampersands; Example: 'dns=www.example.com&dns=www.example2.com' for multiple SANs. Can be made optional if RFC 2818 is disabled on the CA.
478590

479591
![IISU Entry Parameter - SAN](docsource/images/IISU-entry-parameters-store-type-dialog-SAN.png)
480592

@@ -591,6 +703,64 @@ the Keyfactor Command Portal
591703

592704
![WinSql Custom Fields Tab](docsource/images/WinSql-custom-fields-store-type-dialog.png)
593705

706+
707+
###### SPN With Port
708+
Internally set the -IncludePortInSPN option when creating the remote PowerShell connection. Needed for some Kerberos configurations.
709+
710+
![WinSql Custom Field - spnwithport](docsource/images/WinSql-custom-field-spnwithport-dialog.png)
711+
712+
713+
714+
###### WinRM Protocol
715+
Multiple choice value specifying which protocol to use. Protocols https or http use WinRM to connect from Windows to Windows Servers. Using ssh is only supported when running the orchestrator in a Linux environment.
716+
717+
![WinSql Custom Field - WinRM Protocol](docsource/images/WinSql-custom-field-WinRM Protocol-dialog.png)
718+
719+
720+
721+
###### WinRM Port
722+
String value specifying the port number that the Windows target server's WinRM listener is configured to use. Example: '5986' for HTTPS or '5985' for HTTP. By default, when using ssh in a Linux environment, the default port number is 22.
723+
724+
![WinSql Custom Field - WinRM Port](docsource/images/WinSql-custom-field-WinRM Port-dialog.png)
725+
726+
727+
728+
###### Server Username
729+
Username used to log into the target server for establishing the WinRM session. Example: 'administrator' or 'domain\username'.
730+
731+
732+
> [!IMPORTANT]
733+
> This field is created by the `Needs Server` on the Basic tab, do not create this field manually.
734+
735+
736+
737+
738+
###### Server Password
739+
Password corresponding to the Server Username used to log into the target server. When establishing a SSH session from a Linux environment, the password must include the full SSH Private key.
740+
741+
742+
> [!IMPORTANT]
743+
> This field is created by the `Needs Server` on the Basic tab, do not create this field manually.
744+
745+
746+
747+
748+
###### Use SSL
749+
Determine whether the server uses SSL or not (This field is automatically created)
750+
751+
![WinSql Custom Field - ServerUseSsl](docsource/images/WinSql-custom-field-ServerUseSsl-dialog.png)
752+
753+
754+
755+
###### Restart SQL Service After Cert Installed
756+
Boolean value (true or false) indicating whether to restart the SQL Server service after installing the certificate. Example: 'true' to enable service restart after installation.
757+
758+
![WinSql Custom Field - RestartService](docsource/images/WinSql-custom-field-RestartService-dialog.png)
759+
760+
761+
762+
763+
594764
##### Entry Parameters Tab
595765

596766
| Name | Display Name | Description | Type | Default Value | Entry has a private key | Adding an entry | Removing an entry | Reenrolling an entry |
@@ -604,17 +774,20 @@ the Keyfactor Command Portal
604774
![WinSql Entry Parameters Tab](docsource/images/WinSql-entry-parameters-store-type-dialog.png)
605775

606776

607-
##### InstanceName
777+
##### Instance Name
778+
String value specifying the SQL Server instance name to bind the certificate to. Example: 'MSSQLServer' for the default instance or 'Instance1' for a named instance.
608779

609780
![WinSql Entry Parameter - InstanceName](docsource/images/WinSql-entry-parameters-store-type-dialog-InstanceName.png)
610781

611782

612-
##### ProviderName
783+
##### Crypto Provider Name
784+
Name of the Windows cryptographic service provider to use when generating and storing private keys. For more information, refer to the section 'Using Crypto Service Providers'
613785

614786
![WinSql Entry Parameter - ProviderName](docsource/images/WinSql-entry-parameters-store-type-dialog-ProviderName.png)
615787

616788

617789
##### SAN
790+
String value specifying the Subject Alternative Name (SAN) to be used when performing reenrollment jobs. Format as a list of <san_type>=<san_value> entries separated by ampersands; Example: 'dns=www.example.com&dns=www.example2.com' for multiple SANs.
618791

619792
![WinSql Entry Parameter - SAN](docsource/images/WinSql-entry-parameters-store-type-dialog-SAN.png)
620793

@@ -628,15 +801,14 @@ the Keyfactor Command Portal
628801

629802
1. **Download the latest Windows Certificate Universal Orchestrator extension from GitHub.**
630803

631-
Navigate to the [Windows Certificate Universal Orchestrator extension GitHub version page](https://github.com/Keyfactor/iis-orchestrator/releases/latest). Refer to the compatibility matrix below to determine whether the `net6.0` or `net8.0` asset should be downloaded. Then, click the corresponding asset to download the zip archive.
804+
Navigate to the [Windows Certificate Universal Orchestrator extension GitHub version page](https://github.com/Keyfactor/iis-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.
632805

633806
| Universal Orchestrator Version | Latest .NET version installed on the Universal Orchestrator server | `rollForward` condition in `Orchestrator.runtimeconfig.json` | `iis-orchestrator` .NET version to download |
634807
| --------- | ----------- | ----------- | ----------- |
635808
| Older than `11.0.0` | | | `net6.0` |
636809
| Between `11.0.0` and `11.5.1` (inclusive) | `net6.0` | | `net6.0` |
637-
| Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `Disable` | `net6.0` |
638-
| Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `LatestMajor` | `net8.0` |
639-
| `11.6` _and_ newer | `net8.0` | | `net8.0` |
810+
| Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `Disable` | `net6.0` || Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `LatestMajor` | `net8.0` |
811+
| `11.6` _and_ newer | `net8.0` | | `net8.0` |
640812

641813
Unzip the archive containing extension assemblies to a known location.
642814

20.2 KB
Loading
19.7 KB
Loading
20.6 KB
Loading
16.7 KB
Loading
-3 Bytes
Loading
2 Bytes
Loading
20.2 KB
Loading
19.7 KB
Loading
20.6 KB
Loading

0 commit comments

Comments
 (0)