Name
Add-JS7SigningKey
SYNOPSIS
Adds a key pair for signing deployable objects such as workflows to the current account
SYNTAX
Add-JS7SigningKey [-KeyAlgorithm] <String> [[-PrivateKey] <String>] [[-PublicKey] <String>] [[-Certificate] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
DESCRIPTION
Adds a key pair of private key and public key/certificate that can be used to sign deployable objects
such as workflows to the current account.
JS7 supports the following key types: PGP, RSA and ECDSA.
* PGP keys use a private key and a public key.
* RSA and ECDSA use a private key and a signed certificate. The certificate can be self-signed or CA-signed. The public key is not used.
Depending on the security level that JOC Cockpit is operated for one of the following items can be added:
* public key/certificate if security level HIGH is used.
* public key/certificate and private key if security level LOW or MEDIUM are used.
The following REST Web Service API resources are used:
/profile/key/store
PARAMETERS
KeyAlgorithm
-KeyAlgorithm <String>
JS7 supports the following key algorithms: PGP, RSA and ECDSA.
| Required? | true |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
PrivateKey
-PrivateKey <String>
A private key of the type specified with the -KeyAlgorithm parameter is specified.
The private key string is expected to include any newline characters required for the key type.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
PublicKey
-PublicKey <String>
A public key can be specified only when using the PGP key type specified with the -KeyAlgorithm parameter.
The public key string is expected to include any newline characters required for the key type.
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Certificate
-Certificate <String>
A certificate can be specified only when using the RSA, ECDSA key types specified with the -KeyAlgorithm parameter.
The certificate string is expected to include any newline characters required for the key type.
| Required? | false |
| Position? | 4 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditComment
-AuditComment <String>
Specifies a free text that indicates the reason for the current intervention, e.g. "business requirement", "maintenance window" etc.
The Audit Comment is visible from the Audit Log view of the JOC Cockpit.
This parameter is not mandatory. However, the JOC Cockpit can be configured to require Audit Log comments for all interventions.
| Required? | false |
| Position? | 5 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditTimeSpent
-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.
This information is shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JS7.
| Required? | false |
| Position? | 6 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditTicketLink
-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JS7.
This information is shown in the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JS7.
| Required? | false |
| Position? | 7 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Add-JS7SigningKey -KeyAlgorithm RSA -PrivateKey "----BEGIN PGP PRIVATE KEY BLOCK-----\n..." -Certificate "-----BEGIN CERTIFICATE-----\n..."
For RSA and ECDSA key types the certificate and the private key are added if the JOC Cockpit is operated at the LOW or MEDIUM security level.
-------------------------- EXAMPLE 2 --------------------------
PS > Add-JS7SigningKey -KeyAlgorithm RSA -PrivateKey (Get-Content c:/sos/certs/2.0/sos.private-ec-key.pem -Raw) -Certificate (Get-Content c:/sos/certs/2.0/sos.certificate-ec-key.pem -Raw)
The private key and public key are used from raw file input to preserve any newlines in the key files.
-------------------------- EXAMPLE 3 --------------------------
PS > Add-JS7SigningKey -KeyAlgorithm ECDSA -Certificate "-----BEGIN CERTIFICATE-----\n..."
For RSA and ECDSA key types the certificate is added if the JOC Cockpit is operated at the HIGH security level.
-------------------------- EXAMPLE 4 --------------------------
PS > Add-JS7SigningKey -KeyAlgorithm PGP -PrivateKey "-----BEGIN PGP PRIVATE KEY BLOCK-----\n..." -PublicKey "-----BEGIN PGP PUBLIC KEY BLOCK-----\n..."
For PGP key types the public key and the private key are added if JOC Cockpit is operated for security level LOW or MEDIUM.
-------------------------- EXAMPLE 5 --------------------------
PS > Add-JS7SigningKey -KeyAlgorithm PGP -PublicKey "-----BEGIN PGP PUBLIC KEY BLOCK-----\n..."
For PGP key types the public key is added if JOC Cockpit is operated for security level HIGH.
Overview
Content Tools