not-allowed-key-type.md

Extension Error Code: notAllowedKeyType

This specification defines a new error code, to be included in the DID Spec Registries.

Status

Work-in-progress

Syntax

The error code is notAllowedKeyType.

Definition

This DID Resolution error code is used to indicate that a security policy has been triggered, and the DID document contains a key type that is not allowed.

The DID Resolution Metadata MAY include additional information about why the security policy has been triggered.

Examples

{
	"@context": "https://w3id.org/did-resolution/v1",
	"didDocument": null,
	"didResolutionMetadata": {
		"error": "notAllowedKeyType"
	},
	"didDocumentMetadata": {}
}

DID Resolution Option: checkKeyType

This specification also defines a new DID Resolution Option.

Definition

This DID Resolution Option can be used by a client to override the behavior of the security policy.

Possible values:

• error: A DID Resolution Result with error notAllowedKeyType is returned if the security policy is triggered.
• warn: A normal DID Resolution Result is returned, but a warning is included in the didResolutionMetadata field.
• ignore: The security policy is ignored, and a normal DID Resolution Result is returned.

Contribute

Contributions to this document can be discussed in the DIF I&D Working Group:

• https://identity.foundation/working-groups/identifiers-discovery.html
• https://dif.groups.io/g/id-wg/