Apache Mina SSHD 2.15.0 · org.apache.sshd.common.config.keys.OpenSshCertificateImpl

Modifier and Type	Field and Description
private PublicKey	caPubKey
private PublicKey	certificatePublicKey
private List<OpenSshCertificate.CertificateOption>	criticalOptions
private List<OpenSshCertificate.CertificateOption>	extensions
private String	id
private String	keyType
private byte[]	message
private byte[]	nonce
private Collection<String>	principals
private String	reserved
private long	serial
private static final long	serialVersionUID Hides java.security.PublicKey.serialVersionUID, java.security.PrivateKey.serialVersionUID.
private byte[]	signature
private int	type
private long	validAfter
private long	validBefore

Access	Constructor and Description
public	OpenSshCertificateImpl()

Method Summary

Modifier and Type	Method and Description
public String	getAlgorithm() Implements java.security.Key.getAlgorithm. Returns the standard algorithm name for this key.
public PublicKey	getCaPubKey() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getCaPubKey. Retrieves the CA public key of this certificate.
public PublicKey	getCertPubKey() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getCertPubKey. Retrieves the certified public key.
public List<OpenSshCertificate.CertificateOption>	getCriticalOptions() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getCriticalOptions. Retrieves the critical options set in the certificate.
public byte[]	getEncoded() Implements java.security.Key.getEncoded. Returns the key in its primary encoding format, or `null` if this key does not support encoding.
public List<OpenSshCertificate.CertificateOption>	getExtensions() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getExtensions. Retrieves the extensions set in the certificate.
public String	getFormat() Implements java.security.Key.getFormat. Returns the name of the primary encoding format of this key, or `null` if this key does not support encoding.
public String	getId() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getId. Retrieves a free-form text set by the CA when the certificate was generated; intended to identify the identity principal in log message.
public String	getKeyType() Implements org.apache.sshd.common.config.keys.SshPublicKey.getKeyType. Retrieves the SSH key type.
public byte[]	getMessage() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getMessage. Retrieves the raw byte content of the certificate, minus the signature.
public byte[]	getNonce() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getNonce. Retrieves the nonce of this certificate.
public Collection<String>	getPrincipals() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getPrincipals. Retrieves the principals mentioned in the certificate.
public String	getRawKeyType() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getRawKeyType. Retrieves the raw SSH key type of this certificate.
public byte[]	getRawSignature() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getRawSignature. Retrieves the raw signature bytes, without the signature algorithm.
public String	getReserved() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getReserved. Retrieves the "reserved" field of the certificate.
public long	getSerial() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getSerial. Retrieves the serial number of this certificate.
public byte[]	getSignature() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getSignature. Retrieves the signature of the certificate, including the signature algorithm.
public String	getSignatureAlgorithm() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getSignatureAlgorithm. Retrieves the signature algorithm used for the signature.
public OpenSshCertificate.Type	getType() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getType. Retrieves the type of certificate.
public long	getValidAfter() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getValidAfter. Retrieves the time in number of seconds since the `java.time.Instant#EPOCH` at which this certificate becomes or became valid.
public long	getValidBefore() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getValidBefore. Retrieves the time in number of seconds since the `java.time.Instant#EPOCH` at which this certificate becomes or became invalid.
public void	setCaPubKey(PublicKey caPubKey)
public void	setCertPubKey(PublicKey certificatePublicKey)
public void	setCriticalOptions(List<OpenSshCertificate.CertificateOption> criticalOptions)
public void	setExtensions(List<OpenSshCertificate.CertificateOption> extensions)
public void	setId(String id)
public void	setKeyType(String keyType)
public void	setMessage(byte[] message)
public void	setNonce(byte[] nonce)
public void	setPrincipals(Collection<String> principals)
public void	setReserved(String reserved)
public void	setSerial(long serial)
public void	setSignature(byte[] signature)
public void	setType(OpenSshCertificate.Type type)
public void	setValidAfter(long validAfter)
public void	setValidAfter(Instant `Instant` to use for validAfter validAfter) If null, uses `OpenSshCertificate#MIN_EPOCH`
public void	setValidBefore(long validBefore)
public void	setValidBefore(Instant `Instant` to use for validBefore validBefore) If null, uses `OpenSshCertificate#INFINITY`
private static String	toDate(long timestamp)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

caPubKey	back to summary
private PublicKey caPubKey

certificatePublicKey	back to summary
private PublicKey certificatePublicKey

criticalOptions	back to summary
private List<OpenSshCertificate.CertificateOption> criticalOptions

extensions	back to summary
private List<OpenSshCertificate.CertificateOption> extensions

id	back to summary
private String id

keyType	back to summary
private String keyType

message	back to summary
private byte[] message

nonce	back to summary
private byte[] nonce

principals	back to summary
private Collection<String> principals

reserved	back to summary
private String reserved

serial	back to summary
private long serial

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.security.PublicKey.serialVersionUID, java.security.PrivateKey.serialVersionUID.

signature	back to summary
private byte[] signature

type	back to summary
private int type

validAfter	back to summary
private long validAfter

validBefore	back to summary
private long validBefore

OpenSshCertificateImpl	back to summary
public OpenSshCertificateImpl()

Method Detail

getAlgorithm	back to summary
public String getAlgorithm() Implements java.security.Key.getAlgorithm. Doc from java.security.Key.getAlgorithm. Returns the standard algorithm name for this key. For example, "DSA" would indicate that this key is a DSA key. See the key related sections (KeyFactory, KeyGenerator, KeyPairGenerator, and SecretKeyFactory) in the Java Security Standard Algorithm Names Specification for information about standard key algorithm names. Returns:String the name of the algorithm associated with this key. Annotations @Override

getAlgorithm

back to summary

public String getAlgorithm()

Implements java.security.Key.getAlgorithm.

Doc from java.security.Key.getAlgorithm.

Returns the standard algorithm name for this key. For example, "DSA" would indicate that this key is a DSA key. See the key related sections (KeyFactory, KeyGenerator, KeyPairGenerator, and SecretKeyFactory) in the Java Security Standard Algorithm Names Specification for information about standard key algorithm names.

Returns:String

the name of the algorithm associated with this key.

Annotations

@Override

getCaPubKey back to summary

getCaPubKey	back to summary
public PublicKey getCaPubKey() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getCaPubKey. Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getCaPubKey. Retrieves the CA public key of this certificate. Returns:PublicKey the `PublicKey` Annotations @Override

public PublicKey getCaPubKey()

Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getCaPubKey.

Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getCaPubKey.

Retrieves the CA public key of this certificate.

Returns:PublicKey

the PublicKey

Annotations

@Override

getCertPubKey back to summary

getCertPubKey	back to summary
public PublicKey getCertPubKey() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getCertPubKey. Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getCertPubKey. Retrieves the certified public key. Returns:PublicKey the `PublicKey` Annotations @Override

public PublicKey getCertPubKey()

Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getCertPubKey.

Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getCertPubKey.

Retrieves the certified public key.

Returns:PublicKey

the PublicKey

Annotations

@Override

getCriticalOptions back to summary

getCriticalOptions	back to summary
public List<OpenSshCertificate.CertificateOption> getCriticalOptions() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getCriticalOptions. Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getCriticalOptions. Retrieves the critical options set in the certificate. Returns:List<OpenSshCertificate.CertificateOption> the critical options as a list, never `null` but possibly empty Annotations @Override

public List<OpenSshCertificate.CertificateOption> getCriticalOptions()

Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getCriticalOptions.

Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getCriticalOptions.

Retrieves the critical options set in the certificate.

Returns:List<OpenSshCertificate.CertificateOption>

the critical options as a list, never null but possibly empty

Annotations

@Override

getEncoded back to summary

getEncoded	back to summary
public byte[] getEncoded() Implements java.security.Key.getEncoded. Doc from java.security.Key.getEncoded. Returns the key in its primary encoding format, or `null` if this key does not support encoding. Returns:byte[] the encoded key, or `null` if the key does not support encoding. Annotations @Override

public byte[] getEncoded()

Implements java.security.Key.getEncoded.

Doc from java.security.Key.getEncoded.

Returns the key in its primary encoding format, or null if this key does not support encoding.

Returns:byte[]

the encoded key, or null if the key does not support encoding.

Annotations

@Override

getExtensions back to summary

getExtensions	back to summary
public List<OpenSshCertificate.CertificateOption> getExtensions() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getExtensions. Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getExtensions. Retrieves the extensions set in the certificate. Returns:List<OpenSshCertificate.CertificateOption> the extensions as a list, never `null` but possibly empty Annotations @Override

public List<OpenSshCertificate.CertificateOption> getExtensions()

Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getExtensions.

Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getExtensions.

Retrieves the extensions set in the certificate.

Returns:List<OpenSshCertificate.CertificateOption>

the extensions as a list, never null but possibly empty

Annotations

@Override

getFormat back to summary

getFormat	back to summary
public String getFormat() Implements java.security.Key.getFormat. Doc from java.security.Key.getFormat. Returns the name of the primary encoding format of this key, or `null` if this key does not support encoding. The primary encoding format is named in terms of the appropriate ASN.1 data format, if an ASN.1 specification for this key exists. For example, the name of the ASN.1 data format for public keys is SubjectPublicKeyInfo, as defined by the X.509 standard; in this case, the returned format is `"X.509"`. Similarly, the name of the ASN.1 data format for private keys is PrivateKeyInfo, as defined by the PKCS #8 standard; in this case, the returned format is `"PKCS#8"`. Returns:String the primary encoding format of the key. Annotations @Override

public String getFormat()

Implements java.security.Key.getFormat.

Doc from java.security.Key.getFormat.

Returns the name of the primary encoding format of this key, or null if this key does not support encoding. The primary encoding format is named in terms of the appropriate ASN.1 data format, if an ASN.1 specification for this key exists. For example, the name of the ASN.1 data format for public keys is SubjectPublicKeyInfo, as defined by the X.509 standard; in this case, the returned format is "X.509". Similarly, the name of the ASN.1 data format for private keys is PrivateKeyInfo, as defined by the PKCS #8 standard; in this case, the returned format is "PKCS#8".

Returns:String

the primary encoding format of the key.

Annotations

@Override

getId back to summary

getId	back to summary
public String getId() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getId. Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getId. Retrieves a free-form text set by the CA when the certificate was generated; intended to identify the identity principal in log message. Returns:String the id; never `null` but may be empty. Annotations @Override

public String getId()

Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getId.

Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getId.

Retrieves a free-form text set by the CA when the certificate was generated; intended to identify the identity principal in log message.

Returns:String

the id; never null but may be empty.

Annotations

@Override

getKeyType back to summary

getKeyType	back to summary
public String getKeyType() Implements org.apache.sshd.common.config.keys.SshPublicKey.getKeyType. Doc from org.apache.sshd.common.config.keys.SshPublicKey.getKeyType. Retrieves the SSH key type. Returns:String the SSH key type, never `null`. Annotations @Override

public String getKeyType()

Implements org.apache.sshd.common.config.keys.SshPublicKey.getKeyType.

Doc from org.apache.sshd.common.config.keys.SshPublicKey.getKeyType.

Retrieves the SSH key type.

Returns:String

the SSH key type, never null.

Annotations

@Override

getMessage	back to summary
public byte[] getMessage() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getMessage. Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getMessage. Retrieves the raw byte content of the certificate, minus the signature. This is the data that was signed. Returns:byte[] the part of the certificate raw data that was signed Annotations @Override

getMessage

back to summary

public byte[] getMessage()

Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getMessage.

Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getMessage.

Retrieves the raw byte content of the certificate, minus the signature. This is the data that was signed.

Returns:byte[]

the part of the certificate raw data that was signed

Annotations

@Override

getNonce	back to summary
public byte[] getNonce() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getNonce. Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getNonce. Retrieves the nonce of this certificate. Returns:byte[] the nonce. Annotations @Override

getNonce

back to summary

public byte[] getNonce()

Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getNonce.

Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getNonce.

Retrieves the nonce of this certificate.

Returns:byte[]

the nonce.

Annotations

@Override

getPrincipals back to summary

getPrincipals	back to summary
public Collection<String> getPrincipals() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getPrincipals. Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getPrincipals. Retrieves the principals mentioned in the certificate. Returns:Collection<String> the collection of principals, never `null` but possibly empty Annotations @Override

public Collection<String> getPrincipals()

Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getPrincipals.

Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getPrincipals.

Retrieves the principals mentioned in the certificate.

Returns:Collection<String>

the collection of principals, never null but possibly empty

Annotations

@Override

getRawKeyType	back to summary
public String getRawKeyType() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getRawKeyType. Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getRawKeyType. Retrieves the raw SSH key type of this certificate. Returns:String the key type, for instance "ssh-rsa" for a "[email protected]" certificate Annotations @Override

getRawKeyType

back to summary

public String getRawKeyType()

Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getRawKeyType.

Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getRawKeyType.

Retrieves the raw SSH key type of this certificate.

Returns:String

the key type, for instance "ssh-rsa" for a "[email protected]" certificate

Annotations

@Override

getRawSignature	back to summary
public byte[] getRawSignature() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getRawSignature. Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getRawSignature. Retrieves the raw signature bytes, without the signature algorithm. Returns:byte[] the signature bytes Annotations @Override

getRawSignature

back to summary

public byte[] getRawSignature()

Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getRawSignature.

Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getRawSignature.

Retrieves the raw signature bytes, without the signature algorithm.

Returns:byte[]

the signature bytes

Annotations

@Override

getReserved	back to summary
public String getReserved() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getReserved. Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getReserved. Retrieves the "reserved" field of the certificate. OpenSSH currently doesn't use it and ignores it. Returns:String the "reserved" field. Annotations @Override

getReserved

back to summary

public String getReserved()

Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getReserved.

Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getReserved.

Retrieves the "reserved" field of the certificate. OpenSSH currently doesn't use it and ignores it.

Returns:String

the "reserved" field.

Annotations

@Override

getSerial	back to summary
public long getSerial() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getSerial. Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getSerial. Retrieves the serial number of this certificate. Returns:long the serial number Annotations @Override

getSerial

back to summary

public long getSerial()

Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getSerial.

Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getSerial.

Retrieves the serial number of this certificate.

Returns:long

the serial number

Annotations

@Override

getSignature	back to summary
public byte[] getSignature() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getSignature. Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getSignature. Retrieves the signature of the certificate, including the signature algorithm. Returns:byte[] the signature bytes Annotations @Override

getSignature

back to summary

public byte[] getSignature()

Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getSignature.

Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getSignature.

Retrieves the signature of the certificate, including the signature algorithm.

Returns:byte[]

the signature bytes

Annotations

@Override

getSignatureAlgorithm	back to summary
public String getSignatureAlgorithm() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getSignatureAlgorithm. Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getSignatureAlgorithm. Retrieves the signature algorithm used for the signature. Returns:String the signature algorithm as recorded in the certificate Annotations @Override

getSignatureAlgorithm

back to summary

public String getSignatureAlgorithm()

Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getSignatureAlgorithm.

Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getSignatureAlgorithm.

Retrieves the signature algorithm used for the signature.

Returns:String

the signature algorithm as recorded in the certificate

Annotations

@Override

getType back to summary

getType	back to summary
public OpenSshCertificate.Type getType() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getType. Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getType. Retrieves the type of certificate. Returns:OpenSshCertificate.Type the `Type` Annotations @Override

public OpenSshCertificate.Type getType()

Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getType.

Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getType.

Retrieves the type of certificate.

Returns:OpenSshCertificate.Type

the Type

Annotations

@Override

getValidAfter back to summary

getValidAfter	back to summary
public long getValidAfter() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getValidAfter. Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getValidAfter. Retrieves the time in number of seconds since the `java.time.Instant#EPOCH` at which this certificate becomes or became valid. Returns:long the number of seconds since the `java.time.Instant#EPOCH` as an unsigned 64bit value Annotations @Override

public long getValidAfter()

Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getValidAfter.

Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getValidAfter.

Retrieves the time in number of seconds since the java.time.Instant#EPOCH at which this certificate becomes or became valid.

Returns:long

the number of seconds since the java.time.Instant#EPOCH as an unsigned 64bit value

Annotations

@Override

getValidBefore back to summary

getValidBefore	back to summary
public long getValidBefore() Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getValidBefore. Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getValidBefore. Retrieves the time in number of seconds since the `java.time.Instant#EPOCH` at which this certificate becomes or became invalid. Returns:long the number of seconds since the `java.time.Instant#EPOCH` as an unsigned 64bit value Annotations @Override

public long getValidBefore()

Implements org.apache.sshd.common.config.keys.OpenSshCertificate.getValidBefore.

Doc from org.apache.sshd.common.config.keys.OpenSshCertificate.getValidBefore.

Retrieves the time in number of seconds since the java.time.Instant#EPOCH at which this certificate becomes or became invalid.

Returns:long

the number of seconds since the java.time.Instant#EPOCH as an unsigned 64bit value

Annotations

@Override

setCaPubKey	back to summary
public void setCaPubKey(PublicKey caPubKey)

setCertPubKey	back to summary
public void setCertPubKey(PublicKey certificatePublicKey)

setCriticalOptions	back to summary
public void setCriticalOptions(List<OpenSshCertificate.CertificateOption> criticalOptions)

setExtensions	back to summary
public void setExtensions(List<OpenSshCertificate.CertificateOption> extensions)

setId	back to summary
public void setId(String id)

setKeyType	back to summary
public void setKeyType(String keyType)

setMessage	back to summary
public void setMessage(byte[] message)

setNonce	back to summary
public void setNonce(byte[] nonce)

setPrincipals	back to summary
public void setPrincipals(Collection<String> principals)

setReserved	back to summary
public void setReserved(String reserved)

setSerial	back to summary
public void setSerial(long serial)

setSignature	back to summary
public void setSignature(byte[] signature)

setType	back to summary
public void setType(OpenSshCertificate.Type type)

setValidAfter	back to summary
public void setValidAfter(long validAfter)

setValidAfter back to summary

public void setValidAfter(Instant validAfter)

If null, uses OpenSshCertificate#MIN_EPOCH

Parameters

validAfter:Instant: Instant to use for validAfter

setValidBefore	back to summary
public void setValidBefore(long validBefore)

setValidBefore back to summary

public void setValidBefore(Instant validBefore)

If null, uses OpenSshCertificate#INFINITY

Parameters

validBefore:Instant: Instant to use for validBefore

toDate	back to summary
private static String toDate(long timestamp)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class OpenSshCertificateImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail