Bouncy Castle Provider (FIPS Distribution) 1.0.2.5 · org.bouncycastle.asn1.BEROctetString

ASN.1 OctetStrings, with indefinite length rules, and constructed form support.

The Basic Encoding Rules (BER) format allows encoding using so called "constructed form", which DER and CER formats forbid allowing only "primitive form".

This class always produces the constructed form with underlying segments in an indefinite length array. If the input wasn't the same, then this output is not faithful reproduction.

See ASN1OctetString for X.690 encoding rules of OCTET-STRING objects.

Field Summary

Modifier and Type	Field and Description
private final int	chunkSize
private static final int	DEFAULT_LENGTH
private final ASN1OctetString[]	octs

Inherited from org.bouncycastle.asn1.ASN1OctetString:: string

Constructor Summary

Access	Constructor and Description
public	BEROctetString(byte[] the octets making up the octet string. string) Create an OCTET-STRING object from a byte[]
public	BEROctetString(ASN1OctetString[] an array of OCTET STRING to construct the BER OCTET STRING from. octs) Multiple `ASN1OctetString` data blocks are input, the result is constructed form.
public	BEROctetString(byte[] the octets making up the octet string. string, int the number of octets stored in each DER encoded component OCTET STRING. chunkSize) Create an OCTET-STRING object from a byte[]
public	BEROctetString(ASN1OctetString[] an array of OCTET STRING to construct the BER OCTET STRING from. octs, int the number of octets stored in each DER encoded component OCTET STRING. chunkSize) Multiple `ASN1OctetString` data blocks are input, the result is constructed form.
private	BEROctetString(byte[] string, ASN1OctetString[] octs, int chunkSize)

Method Summary

Modifier and Type	Method and Description
public void	encode(ASN1OutputStream out) Implements abstract org.bouncycastle.asn1.ASN1OctetString.encode.
pack-priv int	encodedLength() Implements abstract org.bouncycastle.asn1.ASN1Primitive.encodedLength. Return the length of the encoding this object will produce.
pack-priv static BEROctetString	fromSequence(ASN1Sequence seq)
private Vector<E>	generateOcts()
public Enumeration<E>	Returns: an Enumeration of the component OCTET STRINGs. getObjects() Return the OCTET STRINGs that make up this string.
public byte[]	Returns: the full OCTET STRING. getOctets() Overrides org.bouncycastle.asn1.ASN1OctetString.getOctets. Return a concatenated byte array of all the octets making up the constructed OCTET STRING
pack-priv boolean	isConstructed() Implements abstract org.bouncycastle.asn1.ASN1Primitive.isConstructed. Return true if this objected is a CONSTRUCTED one, false otherwise.
private static byte[]	toBytes(ASN1OctetString[] octs) Convert a vector of octet strings into a single byte string

Inherited from org.bouncycastle.asn1.ASN1OctetString:: asn1Equals getInstance getInstance getLoadedObject getOctetStream hashCode parser toDERObject toDLObject toString

Field Detail

chunkSize	back to summary
private final int chunkSize

DEFAULT_LENGTH	back to summary
private static final int DEFAULT_LENGTH

octs	back to summary
private final ASN1OctetString[] octs

Constructor Detail

BEROctetString	back to summary
public BEROctetString(byte[] string) Create an OCTET-STRING object from a byte[] Parameters string:byte[] the octets making up the octet string.

BEROctetString

back to summary

public BEROctetString(byte[] string)

Create an OCTET-STRING object from a byte[]

Parameters

string:byte[]: the octets making up the octet string.

BEROctetString back to summary

BEROctetString	back to summary
public BEROctetString(ASN1OctetString[] octs) Multiple `ASN1OctetString` data blocks are input, the result is constructed form. Parameters octs:ASN1OctetString[] an array of OCTET STRING to construct the BER OCTET STRING from.

public BEROctetString(ASN1OctetString[] octs)

Multiple ASN1OctetString data blocks are input, the result is constructed form.

Parameters

octs:ASN1OctetString[]: an array of OCTET STRING to construct the BER OCTET STRING from.

BEROctetString	back to summary
public BEROctetString(byte[] string, int chunkSize) Create an OCTET-STRING object from a byte[] Parameters string:byte[] the octets making up the octet string. chunkSize:int the number of octets stored in each DER encoded component OCTET STRING.

BEROctetString

back to summary

public BEROctetString(byte[] string, int chunkSize)

Create an OCTET-STRING object from a byte[]

Parameters

string:byte[]: the octets making up the octet string.
chunkSize:int: the number of octets stored in each DER encoded component OCTET STRING.

BEROctetString back to summary

BEROctetString	back to summary
public BEROctetString(ASN1OctetString[] octs, int chunkSize) Multiple `ASN1OctetString` data blocks are input, the result is constructed form. Parameters octs:ASN1OctetString[] an array of OCTET STRING to construct the BER OCTET STRING from. chunkSize:int the number of octets stored in each DER encoded component OCTET STRING.

public BEROctetString(ASN1OctetString[] octs, int chunkSize)

Multiple ASN1OctetString data blocks are input, the result is constructed form.

Parameters

octs:ASN1OctetString[]: an array of OCTET STRING to construct the BER OCTET STRING from.
chunkSize:int: the number of octets stored in each DER encoded component OCTET STRING.

BEROctetString	back to summary
private BEROctetString(byte[] string, ASN1OctetString[] octs, int chunkSize)

Method Detail

encode	back to summary
public void encode(ASN1OutputStream out) throws IOException Implements abstract org.bouncycastle.asn1.ASN1OctetString.encode.

encodedLength	back to summary
pack-priv int encodedLength() throws IOException Implements abstract org.bouncycastle.asn1.ASN1Primitive.encodedLength. Doc from org.bouncycastle.asn1.ASN1Primitive.encodedLength. Return the length of the encoding this object will produce. Returns:int the length of the object's encoding. Exceptions IOException: if the encoding length cannot be calculated.

encodedLength

back to summary

pack-priv int encodedLength() throws IOException

Implements abstract org.bouncycastle.asn1.ASN1Primitive.encodedLength.

Doc from org.bouncycastle.asn1.ASN1Primitive.encodedLength.

Return the length of the encoding this object will produce.

Returns:int

the length of the object's encoding.

Exceptions

IOException:: if the encoding length cannot be calculated.

fromSequence	back to summary
pack-priv static BEROctetString fromSequence(ASN1Sequence seq)

generateOcts	back to summary
private Vector<E> generateOcts()

getObjects	back to summary
public Enumeration<E> getObjects() Return the OCTET STRINGs that make up this string. Returns:Enumeration<E> an Enumeration of the component OCTET STRINGs.

getObjects

back to summary

public Enumeration<E> getObjects()

Return the OCTET STRINGs that make up this string.

Returns:Enumeration<E>: an Enumeration of the component OCTET STRINGs.

getOctets	back to summary
public byte[] getOctets() Overrides org.bouncycastle.asn1.ASN1OctetString.getOctets. Return a concatenated byte array of all the octets making up the constructed OCTET STRING Returns:byte[] the full OCTET STRING.

getOctets

back to summary

public byte[] getOctets()

Overrides org.bouncycastle.asn1.ASN1OctetString.getOctets.

Return a concatenated byte array of all the octets making up the constructed OCTET STRING

Returns:byte[]: the full OCTET STRING.

isConstructed	back to summary
pack-priv boolean isConstructed() Implements abstract org.bouncycastle.asn1.ASN1Primitive.isConstructed. Doc from org.bouncycastle.asn1.ASN1Primitive.isConstructed. Return true if this objected is a CONSTRUCTED one, false otherwise. Returns:boolean true if CONSTRUCTED bit set on object's tag, false otherwise.

isConstructed

back to summary

pack-priv boolean isConstructed()

Implements abstract org.bouncycastle.asn1.ASN1Primitive.isConstructed.

Doc from org.bouncycastle.asn1.ASN1Primitive.isConstructed.

Return true if this objected is a CONSTRUCTED one, false otherwise.

Returns:boolean: true if CONSTRUCTED bit set on object's tag, false otherwise.

toBytes	back to summary
private static byte[] toBytes(ASN1OctetString[] octs) Convert a vector of octet strings into a single byte string

public Class BEROctetString

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail