Class CertificateRequest

java.lang.Object

org.bouncycastle.tls.CertificateRequest

public class CertificateRequest
extends Object

Parsing and encoding of a CertificateRequest struct from RFC 4346:

struct {
    ClientCertificateType certificate_types<1..2^8-1>;
    DistinguishedName certificate_authorities<3..2^16-1>;
} CertificateRequest;

Updated for RFC 5246:

struct {
    ClientCertificateType certificate_types<1..2^8-1>;
    SignatureAndHashAlgorithm supported_signature_algorithms<2^16-1>;
    DistinguishedName certificate_authorities<0..2^16-1>;
} CertificateRequest;

Revised for RFC 8446:

struct {
    opaque certificate_request_context<0..2^8-1>;
    Extension extensions<2..2^16-1>;
} CertificateRequest;

See Also:

• ClientCertificateType
• X500Name

Field Summary

Fields

Modifier and Type	Field	Description
protected final Vector	certificateAuthorities
protected final byte[]	certificateRequestContext
protected final short[]	certificateTypes
protected final Vector	supportedSignatureAlgorithms
protected final Vector	supportedSignatureAlgorithmsCert

Constructor Summary

Constructors

Constructor	Description
CertificateRequest(byte[] certificateRequestContext, Vector supportedSignatureAlgorithms, Vector supportedSignatureAlgorithmsCert, Vector certificateAuthorities)
CertificateRequest(short[] certificateTypes, Vector supportedSignatureAlgorithms, Vector certificateAuthorities)

Method Summary

Modifier and Type	Method	Description
void	encode(TlsContext context, OutputStream output)	Encode this CertificateRequest to an OutputStream.
Vector	getCertificateAuthorities()
byte[]	getCertificateRequestContext()
short[]	getCertificateTypes()
Vector	getSupportedSignatureAlgorithms()
Vector	getSupportedSignatureAlgorithmsCert()
boolean	hasCertificateRequestContext(byte[] certificateRequestContext)
static CertificateRequest	parse(TlsContext context, InputStream input)	Parse a CertificateRequest from an InputStream.

Methods inherited from class Object

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

Field Details

certificateRequestContext

protected final byte[] certificateRequestContext

certificateTypes

protected final short[] certificateTypes

supportedSignatureAlgorithms

protected final Vector supportedSignatureAlgorithms

supportedSignatureAlgorithmsCert

protected final Vector supportedSignatureAlgorithmsCert

certificateAuthorities

protected final Vector certificateAuthorities

Constructor Details

CertificateRequest

public CertificateRequest(short[] certificateTypes,
 Vector supportedSignatureAlgorithms,
 Vector certificateAuthorities)

Parameters:

certificateTypes - see ClientCertificateType for valid constants.

certificateAuthorities - a Vector of X500Name.

CertificateRequest

public CertificateRequest(byte[] certificateRequestContext,
 Vector supportedSignatureAlgorithms,
 Vector supportedSignatureAlgorithmsCert,
 Vector certificateAuthorities)
                   throws IOException

Throws:

IOException

Method Details

getCertificateRequestContext

public byte[] getCertificateRequestContext()

getCertificateTypes

public short[] getCertificateTypes()

Returns:

an array of certificate types

See Also:

• ClientCertificateType

getSupportedSignatureAlgorithms

public Vector getSupportedSignatureAlgorithms()

Returns:

a Vector of SignatureAndHashAlgorithm (or null before TLS 1.2).

getSupportedSignatureAlgorithmsCert

public Vector getSupportedSignatureAlgorithmsCert()

Returns:

an optional Vector of SignatureAndHashAlgorithm. May be non-null from TLS 1.3 onwards.

getCertificateAuthorities

public Vector getCertificateAuthorities()

Returns:

a Vector of X500Name

hasCertificateRequestContext

public boolean hasCertificateRequestContext(byte[] certificateRequestContext)

encode

public void encode(TlsContext context,
 OutputStream output)
            throws IOException

Encode this CertificateRequest to an OutputStream.

Parameters:

context - the TlsContext of the current connection.

output - the OutputStream to encode to.

Throws:

IOException

parse

public static CertificateRequest parse(TlsContext context,
 InputStream input)
                                throws IOException

Parse a CertificateRequest from an InputStream.

Parameters:

context - the TlsContext of the current connection.

input - the InputStream to parse from.

Returns:

a CertificateRequest object.

Throws:

IOException