Class C509CertificationRequestTemplate

java.lang.Object

org.bouncycastle.cbor.c509.C509CertificationRequestTemplate

public class C509CertificationRequestTemplate
extends Object

A C509 certification request template (Section 4.4 of draft-ietf-cose-cbor-encoded-cert-20), returned by an EST server in response to a GET /csrattrs request to tell the client what its certification request should contain:

C509CertificationRequestTemplate = [
   c509CertificationRequestTemplateType: int,
   c509CertificationRequestType: [+ int] / undefined,
   subjectSignatureAlgorithm: [+ AlgorithmIdentifier] / undefined,
   subject: NameTemplate / undefined,
   subjectPublicKeyAlgorithm: [+ AlgorithmIdentifier] / undefined,
   subjectPublicKey: undefined,
   extensionsRequest: ExtensionsTemplate / undefined,
]

The CBOR simple value undefined marks the fields the client is expected to fill in - represented here as null returns from the accessors.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	C509CertificationRequestTemplate.ExtensionTemplate	An ExtensionTemplate group (Section 4.4): an extension with an "optional" flag and a prescribed or partial value.
static class	C509CertificationRequestTemplate.RDNAttributeTemplate	An RDNAttributeTemplate group (Section 4.4): an attribute type with its minimum and maximum number of occurrences and an optional prescribed value.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TYPE_SIMPLE	Simple C509 Certification Request Template (Section 8.5).

Constructor Summary

Constructors

Constructor	Description
C509CertificationRequestTemplate(int templateType, int[] requestTypes, C509AlgorithmIdentifier[] signatureAlgorithms, C509CertificationRequestTemplate.RDNAttributeTemplate[] subjectTemplate, C509AlgorithmIdentifier[] publicKeyAlgorithms, C509CertificationRequestTemplate.ExtensionTemplate[] extensionsTemplate)	Base constructor.

Method Summary

Modifier and Type	Method	Description
int[]	getCertificationRequestTypes()	Return the certification request types the server accepts, or null when the client chooses.
byte[]	getEncoded()	Return the complete CBOR encoding of this template.
C509CertificationRequestTemplate.ExtensionTemplate[]	getExtensionsTemplate()	Return the extensions template, or null when the client chooses the extension request.
static C509CertificationRequestTemplate	getInstance(byte[] encoding)	Parse a C509 certification request template from its CBOR encoding.
C509AlgorithmIdentifier[]	getSubjectPublicKeyAlgorithms()	Return the subject public key algorithms the server accepts, or null when the client chooses.
C509AlgorithmIdentifier[]	getSubjectSignatureAlgorithms()	Return the subject signature algorithms the server accepts, or null when the client chooses.
C509CertificationRequestTemplate.RDNAttributeTemplate[]	getSubjectTemplate()	Return the subject name template, or null when the client provides the subject.
int	getTemplateType()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TYPE_SIMPLE

public static final int TYPE_SIMPLE

Simple C509 Certification Request Template (Section 8.5).

See Also:

• Constant Field Values

Constructor Details

C509CertificationRequestTemplate

public C509CertificationRequestTemplate(int templateType,
 int[] requestTypes,
 C509AlgorithmIdentifier[] signatureAlgorithms,
 C509CertificationRequestTemplate.RDNAttributeTemplate[] subjectTemplate,
 C509AlgorithmIdentifier[] publicKeyAlgorithms,
 C509CertificationRequestTemplate.ExtensionTemplate[] extensionsTemplate)

Base constructor. Null array arguments stand for the CBOR undefined - fields the client is expected to provide.

Method Details

getInstance

public static C509CertificationRequestTemplate getInstance(byte[] encoding)
                                                    throws IOException

Parse a C509 certification request template from its CBOR encoding.

Throws:

IOException

getEncoded

public byte[] getEncoded()
                  throws IOException

Return the complete CBOR encoding of this template.

Throws:

IOException

getTemplateType

public int getTemplateType()

getCertificationRequestTypes

public int[] getCertificationRequestTypes()

Return the certification request types the server accepts, or null when the client chooses.

getSubjectSignatureAlgorithms

public C509AlgorithmIdentifier[] getSubjectSignatureAlgorithms()

Return the subject signature algorithms the server accepts, or null when the client chooses.

getSubjectTemplate

public C509CertificationRequestTemplate.RDNAttributeTemplate[] getSubjectTemplate()

Return the subject name template, or null when the client provides the subject.

getSubjectPublicKeyAlgorithms

public C509AlgorithmIdentifier[] getSubjectPublicKeyAlgorithms()

Return the subject public key algorithms the server accepts, or null when the client chooses.

getExtensionsTemplate

public C509CertificationRequestTemplate.ExtensionTemplate[] getExtensionsTemplate()

Return the extensions template, or null when the client chooses the extension request.