Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

The <Key> child element of the File CredentialResolver references a private key to load, either from a local file or, rarely, from a remote resource. This is a more verbose equivalent to using the key attribute.

Reference

Attributes

Include Page
CredentialCommonAttributes
CredentialCommonAttributes

In addition the following key-specific settings are supported:

Name

Type

Default

Description

password 

string

Optional password for decrypting the certificate

format 

"PEM", "DER", or "PKCS12"

Optional indicator of key format (auto-detected in most cases)

Child Elements

Include Page
CredentialCommonChildElements
CredentialCommonChildElements

In addition the following key-specific elements are supported:

Name

Cardinality

Description

<Name>

0 or more

Attaches an "alias" to the key to allow for selection of the key based on its name. Also adds the name to the <ds:KeyInfo> element included in XML messages to assist relying parties in identifying which key was used.