Skip to content

keyring_secret_status_get

Guest

Returns detailed information about a secret.

Params

attribute description
id*
string		 The ID of the secret

Return

Returns an object where the key is the certificate id and the value is one of the following structures depending on the secret type.

If there is no data in the secret null must be returned.

pkey_cert

attribute description
type*
'RSA(<lenght>)'| 'EC(<curve>)'|'ED<curve>'		 The type of the key
fingerprint*
string		 The key fingerprint

cert_single

attribute description
version*
1|2|3		 X.509 version
serial_number*
string		 The key serial number
issuer*
string		 The certificate issuer (e.g. C = CZ, ST = Czech Republic, L = Nove Mesto na Morave, O = Racom s.r.o., OU = IT, CN = pytlik, emailAddress = net_admin@racom.eu)
subject*
string		 Certificate subject
not_before*
unsigned integer		 Unix tstam indicating the start of validity period
not_after*
unsigned integer		 Unix tstam indicating the end of validity period
public_key_algorithm*
string		 The Public Key Algorithm (e.g. rsaEncryption)
signature_algorithm*
string		 The Signature Algorithm (e.g. sha256WithRSAEncryption)
fingerprint_cert*
string		 X.509 fingerprint
fingerprint_key*
string		 The key fingerprint
extended_key_usage
string		 Other valid usages (e.g. serverAuth)
subject_alt_name
string		 Subject alternate name (e.g. IP:192.168.1.1)

cert_chain

Returns an array of certificate statuses: [Certificate Status]

Certificate Status

attribute description
version*
1|2|3		 X.509 version
serial_number*
string		 The key serial number
issuer*
string		 The certificate issuer (e.g. C = CZ, ST = Czech Republic, L = Nove Mesto na Morave, O = Racom s.r.o., OU = IT, CN = pytlik, emailAddress = net_admin@racom.eu)
subject*
string		 Certificate subject
not_before*
unsigned integer		 Unix tstam indicating the start of validity period
not_after*
unsigned integer		 Unix tstam indicating the end of validity period
public_key_algorithm*
string		 The Public Key Algorithm (e.g. rsaEncryption)
signature_algorithm*
string		 The Signature Algorithm (e.g. sha256WithRSAEncryption)
fingerprint_cert*
string		 X.509 fingerprint
fingerprint_key*
string		 The key fingerprint
extended_key_usage
string		 Other valid usages (e.g. serverAuth)
subject_alt_name
string		 Subject alternate name (e.g. IP:192.168.1.1)

dhparam

attribute description
length*
number		 The length of the certificate
digest*
unsigned integer		 Hash of the DER file

remote_access

attribute description
fingerprint*
string		 The key fingerprint

ssh_private

attribute description
type*
'RSA(<lenght>)'| 'EC(<curve>)'|'ED<curve>'		 The type of the key
fingerprint*
string		 The key fingerprint

uftp

attribute description
fingerprint*
string		 The key fingerprint

psk

attribute description
digest*
string		 Hash of the secret
length
unsigned integer		 The secret lenght in bytes (not bits)

openvpn

attribute description
digest*
string		 Hash of the secret