Apache Mina SSHD 2.15.0 · org.apache.sshd.certificate.OpenSshCertificateBuilder

Modifier and Type	Field and Description
protected List<OpenSshCertificate.CertificateOption>	criticalOptions
protected List<OpenSshCertificate.CertificateOption>	extensions
protected String	id
protected byte[]	nonce
protected Collection<String>	principals
protected PublicKey	publicKey
protected long	serial
protected static final Map<String, String>	SIGNATURE_ALGORITHM_MAP
protected final OpenSshCertificate.Type	type
protected long	validAfter
protected long	validBefore

Access	Constructor and Description
protected	OpenSshCertificateBuilder(OpenSshCertificate.Type type)

Method Summary

Modifier and Type	Method and Description
public OpenSshCertificateBuilder	criticalOptions(List<OpenSshCertificate.CertificateOption> criticalOptions)
public OpenSshCertificateBuilder	extensions(List<OpenSshCertificate.CertificateOption> extensions)
public static OpenSshCertificateBuilder	hostCertificate()
public OpenSshCertificateBuilder	id(String id)
private List<OpenSshCertificate.CertificateOption>	Returns: a list containing the options in lexical order lexicallyOrderOptions(List<OpenSshCertificate.CertificateOption> the options to order options) Lexically orders certificate options by name.
public OpenSshCertificateBuilder	nonce(byte[] nonce)
public OpenSshCertificateBuilder	principals(Collection<String> principals)
public OpenSshCertificateBuilder	publicKey(PublicKey publicKey)
public OpenSshCertificateBuilder	serial(long serial)
public OpenSshCertificate	Returns: the signed certificate sign(KeyPair CA key used to sign caKeypair) Creates a certificate signed with the given CA key.
public OpenSshCertificate	Returns: the signed certificate sign(KeyPair CA key used to sign caKeypair, String to use; if `null` automatically chosen based on the CA key type signatureAlgorithm) Creates a certificate signed with the given CA key using the specified signature algorithm.
public static OpenSshCertificateBuilder	userCertificate()
public OpenSshCertificateBuilder	validAfter(long validAfter)
public OpenSshCertificateBuilder	Returns: Self reference validAfter(Instant `Instant` to use for validBefore validAfter) If null, uses `OpenSshCertificate#MIN_EPOCH`
protected void	validate()
private void	validateOptions(List<OpenSshCertificate.CertificateOption> the options to check options) Validates that there are no duplicate options.
public OpenSshCertificateBuilder	validBefore(long validBefore)
public OpenSshCertificateBuilder	Returns: Self reference validBefore(Instant `Instant` to use for validBefore validBefore) If null, uses `OpenSshCertificate#INFINITY`

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

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

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

id	back to summary
protected String id

nonce	back to summary
protected byte[] nonce

principals	back to summary
protected Collection<String> principals

publicKey	back to summary
protected PublicKey publicKey

serial	back to summary
protected long serial

SIGNATURE_ALGORITHM_MAP	back to summary
protected static final Map<String, String> SIGNATURE_ALGORITHM_MAP

type	back to summary
protected final OpenSshCertificate.Type type

validAfter	back to summary
protected long validAfter

validBefore	back to summary
protected long validBefore

OpenSshCertificateBuilder	back to summary
protected OpenSshCertificateBuilder(OpenSshCertificate.Type type)

Method Detail

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

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

hostCertificate	back to summary
public static OpenSshCertificateBuilder hostCertificate()

id	back to summary
public OpenSshCertificateBuilder id(String id)

lexicallyOrderOptions	back to summary
private List<OpenSshCertificate.CertificateOption> lexicallyOrderOptions(List<OpenSshCertificate.CertificateOption> options) Lexically orders certificate options by name. Parameters options:List<OpenSshCertificate.CertificateOption> the options to order Returns:List<OpenSshCertificate.CertificateOption> a list containing the options in lexical order

lexicallyOrderOptions

back to summary

private List<OpenSshCertificate.CertificateOption> lexicallyOrderOptions(List<OpenSshCertificate.CertificateOption> options)

Lexically orders certificate options by name.

Parameters

options:List<OpenSshCertificate.CertificateOption>: the options to order

Returns:List<OpenSshCertificate.CertificateOption>

a list containing the options in lexical order

nonce	back to summary
public OpenSshCertificateBuilder nonce(byte[] nonce)

principals	back to summary
public OpenSshCertificateBuilder principals(Collection<String> principals)

publicKey	back to summary
public OpenSshCertificateBuilder publicKey(PublicKey publicKey)

serial	back to summary
public OpenSshCertificateBuilder serial(long serial)

sign	back to summary
public OpenSshCertificate sign(KeyPair caKeypair) throws Exception Creates a certificate signed with the given CA key. For RSA keys "rsa-sha2-512" is used for the signature. Parameters caKeypair:KeyPair CA key used to sign Returns:OpenSshCertificate the signed certificate Exceptions Exception: if an error occurred

sign

back to summary

public OpenSshCertificate sign(KeyPair caKeypair) throws Exception

Creates a certificate signed with the given CA key. For RSA keys "rsa-sha2-512" is used for the signature.

Parameters

caKeypair:KeyPair: CA key used to sign

Returns:OpenSshCertificate

the signed certificate

Exceptions

Exception:: if an error occurred

sign back to summary

sign	back to summary
public OpenSshCertificate sign(KeyPair caKeypair, String signatureAlgorithm) throws Exception Creates a certificate signed with the given CA key using the specified signature algorithm. If a signature algorithm is given, it must be appropriate for the CA key type, otherwise an exception is thrown. If `signatureAlgorithm == null`, an appropriate signature algorithm is chosen automatically, for RSA keys "rsa-sha2-512" is used then. Parameters caKeypair:KeyPair CA key used to sign signatureAlgorithm:String to use; if `null` automatically chosen based on the CA key type Returns:OpenSshCertificate the signed certificate Exceptions Exception: if an error occurred

public OpenSshCertificate sign(KeyPair caKeypair, String signatureAlgorithm) throws Exception

Creates a certificate signed with the given CA key using the specified signature algorithm. If a signature algorithm is given, it must be appropriate for the CA key type, otherwise an exception is thrown. If signatureAlgorithm == null, an appropriate signature algorithm is chosen automatically, for RSA keys "rsa-sha2-512" is used then.

Parameters

caKeypair:KeyPair: CA key used to sign
signatureAlgorithm:String: to use; if null automatically chosen based on the CA key type

Returns:OpenSshCertificate

the signed certificate

Exceptions

Exception:: if an error occurred

userCertificate	back to summary
public static OpenSshCertificateBuilder userCertificate()

validAfter	back to summary
public OpenSshCertificateBuilder validAfter(long validAfter)

validAfter back to summary

validAfter	back to summary
public OpenSshCertificateBuilder validAfter(Instant validAfter) If null, uses `OpenSshCertificate#MIN_EPOCH` Parameters validAfter:Instant `Instant` to use for validBefore Returns:OpenSshCertificateBuilder Self reference

public OpenSshCertificateBuilder validAfter(Instant validAfter)

If null, uses OpenSshCertificate#MIN_EPOCH

Parameters

validAfter:Instant: Instant to use for validBefore

Returns:OpenSshCertificateBuilder

Self reference

validate	back to summary
protected void validate()

validateOptions	back to summary
private void validateOptions(List<OpenSshCertificate.CertificateOption> options) Validates that there are no duplicate options. Parameters options:List<OpenSshCertificate.CertificateOption> the options to check Exceptions IllegalArgumentException: if there are duplicates

validateOptions

back to summary

private void validateOptions(List<OpenSshCertificate.CertificateOption> options)

Validates that there are no duplicate options.

Parameters

options:List<OpenSshCertificate.CertificateOption>: the options to check

Exceptions

IllegalArgumentException:: if there are duplicates

validBefore	back to summary
public OpenSshCertificateBuilder validBefore(long validBefore)

validBefore back to summary

validBefore	back to summary
public OpenSshCertificateBuilder validBefore(Instant validBefore) If null, uses `OpenSshCertificate#INFINITY` Parameters validBefore:Instant `Instant` to use for validBefore Returns:OpenSshCertificateBuilder Self reference

public OpenSshCertificateBuilder validBefore(Instant validBefore)

If null, uses OpenSshCertificate#INFINITY

Parameters

validBefore:Instant: Instant to use for validBefore

Returns:OpenSshCertificateBuilder

Self reference

public Class OpenSshCertificateBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail