Home/ Manual/ rnp / functions/ rnp_key_export_revocation

rnp_key_export_revocation

PHP function Edit on GitHub ✎

(PECL rnp >= 0.1.1)

Generate and export primary key revocation signature

Description

rnp_key_export_revocation(RnpFFI $ffi, string $key_fp, int $flags, [array $options]): string|false

Note: to revoke a key you'll need to import this signature into the keystore or use rnp_key_revoke() function.

ffi

Ffi-description

key_fp

Key fingerprint of the primary key to be revoked.

flags

RNP_KEY_EXPORT_ARMORED or 0.

options

An associative array with options.

Key	Data type	Description
`"hash"`	string	Set hash algorithm used during signature calculation.
`"code"`	string	Code reason for revocation code. Possible values: 'no', 'superseded', 'compromised', 'retired'. If not defined, then value 'no' will be used by default.
`"reason"`	string	Textual representation of the reason for revocation.

Exported revocation signature on successFalseforfailure.