Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

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

The <Key><Certificate> and <CRL> child elements share support for the following attributes:

Name

Type

Default

Description

backingFilePath 

local pathname


If a <URL> child element is used, this attribute is required in order to provide a local location to save a copy of the remote resource

reloadChanges 

boolean

true

If a <Path> child element is used, controls whether changes to the file are monitored in order to reload the information

reloadInterval 

time in seconds

0

If non-zero, and a <URL> child element is used, indicates the maximum elapsed time in seconds after which the URL will be checked for changes

In addition the following key-specific settings are supported:

NameTypeDefaultDescription

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

The <Key><Certificate>, and <CRL> elements share the following child elements:

Name

Cardinality

Description

<Path>

0 or 1 (<Key>)
0 or more (<Certificate>,<CRL>)

Contains a pathname for the containing element

<URL>

0 or 1

Contains a remote URL for the containing element

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.

  • No labels