Secret label default mappings
The following sections list the secret labels used by the AM features and their default mappings, if any.
General
PEM decryption password
The following table shows the secret label in which you can store the password used to decrypt password-encrypted PEM files.
Encode the password using the https://am.example.com:8443/am/encode.jsp page.
| Secret label | Default alias | Algorithms |
|---|---|---|
|
Encode using |
Encrypt client-side sessions
The following table shows the secret label mapping to use when encrypting client-side sessions:
| Secret label | Default alias | Algorithms |
|---|---|---|
|
RS256 |
|
|
|
AES256 |
|
|
RS256 |
(1) This secret label replaces the legacy Encryption Symmetric AES Key configuration property (under Configure > Global Services > Sessions > Advanced). If you set both the configuration property and the secret label mapping, the mapping takes precedence.
(2) This secret label is deprecated and will be removed in a future release. Use the algorithm-specific secret labels in this table instead. These secret labels make it easier to configure and rotate secrets.
Sign client-side sessions
The following table shows the secret label mapping to use when signing client-side sessions:
| Secret label | Default alias | Algorithms |
|---|---|---|
|
RS256 |
|
|
ES256 |
|
|
ES384 |
|
|
ES512 |
|
|
|
HMAC |
|
|
RS256 |
(1) This secret label replaces the legacy Signing HMAC Shared Secret configuration property (under Configure > Global Services > Sessions > Advanced). If you set both the configuration property and the secret label mapping, the mapping takes precedence.
(2) This secret label is deprecated and will be removed in a future release. Use the algorithm-specific secret labels in this table instead. These secret labels make it easier to migrate and rotate secrets. If you set this secret label and an algorithm-specific secret label, the algorithm-specific label takes precedence.
mTLS certificate for the CRL cache server
The secret label mapping to encrypt the certificate used to authenticate to the CRL cache server.
Learn more about CRL caching in Certificate revocation list caching.
| Secret label | Default alias | Algorithms |
|---|---|---|
|
HTTP client proxy password secret
The secret label mapping for the HTTP client proxy password used to authenticate HTTP outbound requests.
| Secret label | Default alias | Algorithms |
|---|---|---|
|
WebAuthn Metadata
AM verifies the FIDO metadata blob signature against secrets mapped to this secret label.
| Secret label | Default alias | Algorithms |
|---|---|---|
|
Attestation certificates
Google hardware attestation root certificate
This table shows the ID for the Google hardware attestation root certificate.
This certificate is used to confirm the keys used by bound Android devices are valid, have not been revoked, and use hardware-backed security storage.
Refer to Verifying hardware-backed key pairs with Key Attestation in the Android developer documentation.
| Secret label | Default alias | Algorithms |
|---|---|---|
|
RSA / X.509 |
Authentication
Encrypt authentication tree secure state data
The following table shows the secret label mapping used to encrypt sensitive data stored in the secure state of an authentication tree:
| Secret label | Default alias | Algorithms |
|---|---|---|
|
|
AES 256-bit |
Sign authentication requests
The secret label mappings for the HMAC secret used to sign and verify the authentication token (authID):
| Secret label | Default alias | Algorithms |
|---|---|---|
|
|
This mapping overrides the randomly-generated core authentication attribute, Organization Authentication Signing Secret.
You can map multiple secrets to this label to enable secret rotation. AM signs the authentication token with the active secret but checks all mapped secrets when verifying the authentication token signature. Therefore, if you rotate the active secret while an authentication request is in progress, the returned authentication token can still be verified.
If you delete the secret that was used to sign an authentication token, the authID returned in the authentication
request can’t be verified and authentication fails.
Authentication nodes
The dynamic secret labels for authentication nodes, where identifier is defined in the node configuration:
| Node | Secret label |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Encrypted device storage services
Encrypt device storage services
The secret label mappings for services that use encrypted device storage.
These mappings override the encryption keys set in the service configuration.
| Service | Secret label |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Http Client service
HTTP client mTLS certificates
The following table shows the secret label mappings for CA certificates used by the httpclient script binding to secure HTTP requests.
| Secret label | Default alias | Algorithms |
|---|---|---|
|
||
|
(1) Map the am.services.httpclient.mtls.clientcert.identifier.secret dynamic secret
label to the certificate to be used by the httpclient script binding when making HTTP requests.
The identifier is the value of the Client Certificate Secret Label Identifier set in the HTTP Client service configuration.
(2) Map the am.services.httpclient.mtls.servertrustcerts.identifier.secret dynamic secret
label to the truststore of certificates that verify the server certificate. The identifier is the value of the Server Trust Certificate Secret Label Identifier set in the HTTP Client service configuration.
HTTP client proxy connection
The following table shows the secret label mappings used by the httpclient script binding to route HTTP requests through a proxy connection.
| Secret label | Default alias | Algorithms |
|---|---|---|
|
(1) Map the am.services.httpclient.proxy.identifier.secret dynamic secret
label to the secret to be used by the httpclient script binding when making HTTP requests.
The identifier is the value of the Proxy Secret Label Identifier set in the HTTP Client service configuration.
IoT
IoT trusted JWT issuer
The following table shows the secret label mapping that the IoT service uses when configured as a trusted OAuth 2.0 JWT issuer:
| Secret label | Default alias | Algorithms |
|---|---|---|
|
|
HS256 |
IoT certificate verification
The following table shows the secret label mapping for the CA certificate that the Register Thing node uses to verify the X.509 digital certificate included in the proof-of-possession JWT:
| Secret label | Default alias | Algorithms |
|---|---|---|
|
OAuth 2.0 and OpenID Connect
As provider
JWT authenticity signing
The following table shows the secret label mapping used to sign several OAuth 2.0 and OpenID Connect-related JWTs:
| Secret label | Default alias | Algorithms |
|---|---|---|
|
|
HS256 |
|
This key is used to sign the following tokens and requests:
|
Encrypt client-side OAuth 2.0 tokens
This table shows the secret label mapping used to encrypt client-side access tokens:
| Secret label | Default alias | Algorithms |
|---|---|---|
|
|
A128CBC-HS256 |
Sign client-side OAuth 2.0 tokens
This table shows the secret label mappings used to sign client-side access tokens:
| Secret label | Default alias | Algorithms |
|---|---|---|
|
|
ES256 |
|
|
ES384 |
|
|
ES512 |
|
|
HS256 |
|
|
PS256 |
Authenticate OAuth 2.0 clients
The secret label mappings used to authenticate OAuth 2.0 clients:
| Secret label | Default alias | Algorithms |
|---|---|---|
|
||
|
||
|
||
|
(1) Map the am.applications.oauth2.client.identifier.secret dynamic secret label to override the OAuth 2.0
client’s Client secret property, where identifier is the value of the Secret Label
Identifier set in the client configuration.
(2) Map the am.applications.oauth2.client.identifier.jwt.public.key dynamic secret label to override the
OAuth 2.0 client’s Client JWT Bearer Public Key, where identifier is the value of the
Secret Label Identifier set in the client configuration.
(3) Map the am.applications.oauth2.client.identifier.mtls.trusted.cert dynamic secret label to override the
OAuth 2.0 client’s mTLS Self-Signed Certificate, where identifier is the value of the
Secret Label Identifier set in the client configuration.
(4) Map the am.applications.oauth2.client.identifier.id.token.enc.public.key dynamic secret label to
override the OAuth 2.0 client’s ID Token Encryption Public Key, where identifier is the value of the
Secret Label Identifier set in the client configuration.
Sign remote consent requests
This table shows the secret label mappings used to sign remote consent requests:
| Secret label | Default alias | Algorithms(1) |
|---|---|---|
|
|
ES256 |
|
|
ES384 |
|
|
ES512 |
|
|
RS256 |
(1) If you select an HMAC algorithm for signing consent requests (HS256, HS384, or HS512), the value of the Remote Consent Service secret property is used, instead of an entry from the secret stores.
Because the HMAC secret is shared between AM and the remote consent client,
a malicious user compromising the client could create tokens that AM would trust.
To protect against misuse, AM also signs the token using a non-shared signing key
configured in the am.services.oauth2.jwt.authenticity.signing secret label.
Decrypt remote consent responses
This table shows the secret label mapping used to decrypt remote consent responses:
| Secret label | Default alias | Algorithms(1) |
|---|---|---|
|
|
RSA-OAEP-256 |
(1) If you select an algorithm other than RSA-OAEP-256 for decrypting consent responses, the value of the Remote Consent Service secret property is used, instead of an entry from the secret stores.
OAuth 2.0 example Remote Consent service
This table shows the secret label mappings used for the example Remote Consent service:
| Secret label | Default alias | Algorithms |
|---|---|---|
|
|
RS256 |
|
|
RSA-OAEP-256 |
Salt hashes
The secret label for salting hashes in OAuth 2.0 and OIDC flows.
| Secret label | Default alias | Algorithms |
|---|---|---|
|
Use this secret label instead of setting Subject Identifier Hash Salt in the provider configuration.
This secret can’t be rotated.
Decrypt OIDC request parameters
This table shows the secret label mapping used to decrypt OIDC request parameters:
| Secret label | Default alias | Algorithms(1) |
|---|---|---|
|
|
RSA with PKCS#1 v1.5 padding |
|
|
RSA with OAEP with SHA-1 and MGF-1 |
|
|
RSA with OAEP with SHA-256 and MGF-1 |
(1) The following applies to confidential clients only:
If you select an AES algorithm (A128KW, A192KW, or A256KW) or the direct encryption algorithm (dir), the value of the Client Secret field in the OAuth 2.0 Client is used as the secret instead of an entry from the secret stores.
The following signing and encryption algorithms use the Client Secret field to store the secret:
-
Signing ID tokens with an HMAC algorithm
-
Encrypting ID tokens with AES or direct encryption
-
Encrypting parameters with AES or direct encryption
Store only one secret in the Client Secret field; AM will use different mechanisms to sign and encrypt depending on the algorithm, as explained in the OpenID Connect Core 1.0 errata set 1 specification.
Sign OIDC tokens
The following table shows the secret label mapping used to sign OIDC ID tokens and backchannel logout tokens:
| Secret label | Default alias | Algorithms(1) |
|---|---|---|
|
|
ES256 |
|
|
ES384 |
|
|
ES512 |
|
|
PS256 |
|
EdDSA with SHA-512 |
(1) The following applies to confidential clients only:
If you select an HMAC algorithm for signing ID tokens (HS256, HS384, or HS512), the Client Secret property value in the OAuth 2.0 Client is used as the HMAC secret instead of an entry from the secret stores.
Since the HMAC secret is shared between AM and the client,
a malicious user compromising the client could potentially create tokens that AM would trust.
Therefore, to protect against misuse, AM also signs the token
using a non-shared signing key configured in the am.services.oauth2.jwt.authenticity.signing secret label.
CA certificates used in mTLS client authentication
This table shows the secret label mapping used to store the CA certificates AM should trust during mTLS client authentication:
| Secret label | Default alias | Algorithms |
|---|---|---|
|
As client/relying party of the Social Identity Provider service
Decrypt ID tokens
This table shows the secret label mapping to support decryption of ID tokens and userinfo endpoint data
in JWT format when AM is configured as a relying party of the Social Identity Provider Service:
| Secret label | Default alias | Algorithms |
|---|---|---|
|
|
Consult the |
The public key is exposed in the /oauth2/connect/rp/jwk_uri.
For more information about the algorithms supported, and how to configure this secret label mapping, refer to Social authentication.
Sign JWTs and objects
This table shows the secret label mapping that AM uses to sign JWTs and objects when configured as a relying party of the Social Identity Provider Service:
| Secret label | Default alias | Algorithms |
|---|---|---|
|
|
Consult the |
The public key is exposed in the /oauth2/connect/rp/jwk_uri.
For more information about the algorithms supported, and how to configure this secret label mapping, refer to Social authentication.
CA certificates used in mTLS client authentication (RP)
The following table shows the secret label mapping used to store CA or self-signed certificates AM uses for mTLS client authentication when configured as a relying party of the Social Identity Provider service:
| Secret label | Default alias | Algorithms |
|---|---|---|
|
Consult the |
The public key is exposed in the /oauth2/connect/rp/jwk_uri.
For more information about the algorithms supported, and how to configure this secret label mapping, refer to Social authentication.
Policy Configuration service
Policy Configuration service
The secret label mappings to encrypt the certificate used to authenticate Policy Configuration service connections:
| Secret label | Default alias | Algorithms |
|---|---|---|
|
Push Notification service
Push Notification service
The secret label mapping for the Amazon Simple Notification Service access key used by the Push Notification service. The secret mapping overrides the SNS Access Key Secret set in the service configuration.
| Secret label | Default alias | Algorithms |
|---|---|---|
|
SAML 2.0
Encrypt SAML 2.0 session storage JWTs
This table shows the secret label mapping used to encrypt the JWTs SAML 2.0 creates in session storage:
| Secret label | Default alias | Algorithms |
|---|---|---|
|
|
A256GCM |
Sign SAML 2.0 metadata
This table shows the secret label mappings used to sign SAML 2.0 metadata:
| Secret label | Default alias | Algorithms |
|---|---|---|
|
|
RSA SHA-256 |
SAML 2.0 signing and encryption
The following table shows the secret label mappings used to sign and encrypt SAML 2.0 elements, and to enable mTLS authentication between entity providers:
| Secret label | Default alias | Algorithms |
|---|---|---|
|
|
RSA with PKCS#1 v1.5 padding |
|
|
RSA SHA-1(1) |
|
|
RSA with PKCS#1 v1.5 padding |
|
|
RSA SHA-1(1) |
|
||
|
(1) This algorithm is for compatibility purposes only. Avoid its use.
(2) For artifact resolution requests only, the SP uses the certificates mapped to this secret label for mTLS
authentication to the remote IdP. These certificates are exported with <KeyDescriptor use="signing"> in the SP metadata.
(3) The SP uses the certificate mapped to this secret label for basic authentication. If you set a Secret Label
Identifier, and AM finds a mapping to am.applications.federation.entity.providers.saml2.identifier
.basicauth, AM uses this secret and ignores the value of the Password field. For basic authentication,
there is no default secret label for the realm, or globally.
You can specify a custom Secret Label Identifier for each SAML 2.0 entity provider in a realm. AM generates new secret labels that can be unique to the provider, or shared by multiple providers.
For example, you could add a custom secret label identifier named mySamlSecrets to a hosted identity provider. AM then dynamically creates the following secret labels, which the hosted identity provider uses for signing and encryption:
-
am.applications.federation.entity.providers.saml2.mySamlSecrets.signing -
am.applications.federation.entity.providers.saml2.mySamlSecrets.encryption
AM attempts to look up the secrets with the custom secret label identifier. If unsuccessful, AM looks up the secrets using the default secret labels.
UMA
UMA persisted claims tokens
The secret label mappings to encrypt UMA persisted claims tokens (PCTs):
| Secret label | Default alias | Algorithms |
|---|---|---|
|
|