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

ASN.1 SET and SET OF constructs.

Note

This does not know which syntax the set is! (The difference: ordering of SET elements or not ordering.)

DER form is always definite form length fields, while BER support uses indefinite form.

The CER form support does not exist.

X.690

8: Basic encoding rules

8.11 Encoding of a set value

8.11.1 The encoding of a set value shall be constructed

8.11.2 The contents octets shall consist of the complete encoding of a data value from each of the types listed in the ASN.1 definition of the set type, in an order chosen by the sender, unless the type was referenced with the keyword OPTIONAL or the keyword DEFAULT.

8.11.3 The encoding of a data value may, but need not, be present for a type which was referenced with the keyword OPTIONAL or the keyword DEFAULT.

NOTE — The order of data values in a set value is not significant, and places no constraints on the order during transfer

8.12 Encoding of a set-of value

8.12.1 The encoding of a set-of value shall be constructed.

8.12.2 The text of 8.10.2 applies: The contents octets shall consist of zero, one or more complete encodings of data values from the type listed in the ASN.1 definition.

8.12.3 The order of data values need not be preserved by the encoding and subsequent decoding.

9: Canonical encoding rules

9.1 Length forms

If the encoding is constructed, it shall employ the indefinite-length form. If the encoding is primitive, it shall include the fewest length octets necessary. [Contrast with 8.1.3.2 b).]

9.3 Set components

The encodings of the component values of a set value shall appear in an order determined by their tags as specified in 8.6 of ITU-T Rec. X.680 | ISO/IEC 8824-1. Additionally, for the purposes of determining the order in which components are encoded when one or more component is an untagged choice type, each untagged choice type is ordered as though it has a tag equal to that of the smallest tag in that choice type or any untagged choice types nested within.

10: Distinguished encoding rules

10.1 Length forms

The definite form of length encoding shall be used, encoded in the minimum number of octets. [Contrast with 8.1.3.2 b).]

10.3 Set components

The encodings of the component values of a set value shall appear in an order determined by their tags as specified in 8.6 of ITU-T Rec. X.680 | ISO/IEC 8824-1.

NOTE — Where a component of the set is an untagged choice type, the location of that component in the ordering will depend on the tag of the choice component being encoded.

11: Restrictions on BER employed by both CER and DER

11.5 Set and sequence components with default value

The encoding of a set value or sequence value shall not include an encoding for any component value which is equal to its default value.

11.6 Set-of components

The encodings of the component values of a set-of value shall appear in ascending order, the encodings being compared as octet strings with the shorter components being padded at their trailing end with 0-octets.

NOTE — The padding octets are for comparison purposes only and do not appear in the encodings.

Field Summary

Modifier and Type	Field and Description
private boolean	isSorted
private Vector<E>	set
protected Vector<E>	sortedElements

Constructor Summary

Access	Constructor and Description
protected	ASN1Set()
protected	ASN1Set(ASN1Encodable object to be added to the SET. obj) Create a SET containing one object
protected	ASN1Set(ASN1EncodableVector a vector of objects to make up the SET. v, boolean true if should be sorted DER style, false otherwise. doSort) Create a SET containing a vector of objects.
protected	ASN1Set(ASN1Encodable[] an array of objects to make up the SET. array, boolean true if should be sorted DER style, false otherwise. doSort) Create a SET containing an array of objects.

Method Summary

Modifier and Type	Method and Description
pack-priv boolean	asn1Equals(ASN1Primitive o) Implements abstract org.bouncycastle.asn1.ASN1Primitive.asn1Equals. Equality (similarity) comparison for two ASN1Primitive objects.
pack-priv abstract void	encode(ASN1OutputStream out) Implements abstract org.bouncycastle.asn1.ASN1Primitive.encode.
private byte[]	getDEREncoded(ASN1Encodable obj)
public static ASN1Set	Returns: an ASN1Set instance, or null. getInstance(Object the object we want converted. obj) return an ASN1Set from the given object.
public static ASN1Set	Returns: an ASN1Set instance. getInstance(ASN1TaggedObject the tagged object. obj, boolean true if the object is meant to be explicitly tagged false otherwise. explicit) Return an ASN1 set from a tagged object.
private ASN1Encodable	getNext(Enumeration<E> e)
public ASN1Encodable	Returns: the object at the set position indicated by index. getObjectAt(int the set number (starting at zero) of the object index) return the object at the set position indicated by index.
public Enumeration<E>	getObjects()
public int	hashCode() Implements abstract org.bouncycastle.asn1.ASN1Primitive.hashCode. Returns a hash code value for this object.
pack-priv boolean	isConstructed() Implements abstract org.bouncycastle.asn1.ASN1Primitive.isConstructed. Return true if this objected is a CONSTRUCTED one, false otherwise.
public Iterator<ASN1Encodable>	iterator() Implements org.bouncycastle.util.Iterable.iterator. Returns an iterator over a set of elements of type T.
private boolean	lessThanOrEqual(byte[] a, byte[] b) return true if a <= b (arrays are assumed padded with zeros).
public ASN1SetParser	parser()
public int	Returns: the number of objects in this set. size() return the number of objects in this set.
protected void	sort()
public ASN1Encodable[]	toArray()
pack-priv ASN1Primitive	toDERObject() Overrides org.bouncycastle.asn1.ASN1Primitive.toDERObject. Change current SET object to be encoded as `DERSet`.
pack-priv ASN1Primitive	toDLObject() Overrides org.bouncycastle.asn1.ASN1Primitive.toDLObject. Change current SET object to be encoded as `DLSet`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.bouncycastle.asn1.ASN1Primitive:: encodedLength equals fromByteArray toASN1Primitive

Field Detail

isSorted	back to summary
private boolean isSorted

set	back to summary
private Vector<E> set

sortedElements	back to summary
protected Vector<E> sortedElements

Constructor Detail

ASN1Set	back to summary
protected ASN1Set()

ASN1Set	back to summary
protected ASN1Set(ASN1Encodable obj) Create a SET containing one object Parameters obj:ASN1Encodable object to be added to the SET.

ASN1Set

back to summary

protected ASN1Set(ASN1Encodable obj)

Create a SET containing one object

Parameters

obj:ASN1Encodable: object to be added to the SET.

ASN1Set	back to summary
protected ASN1Set(ASN1EncodableVector v, boolean doSort) Create a SET containing a vector of objects. Parameters v:ASN1EncodableVector a vector of objects to make up the SET. doSort:boolean true if should be sorted DER style, false otherwise.

ASN1Set

back to summary

protected ASN1Set(ASN1EncodableVector v, boolean doSort)

Create a SET containing a vector of objects.

Parameters

v:ASN1EncodableVector: a vector of objects to make up the SET.
doSort:boolean: true if should be sorted DER style, false otherwise.

ASN1Set	back to summary
protected ASN1Set(ASN1Encodable[] array, boolean doSort) Create a SET containing an array of objects. Parameters array:ASN1Encodable[] an array of objects to make up the SET. doSort:boolean true if should be sorted DER style, false otherwise.

ASN1Set

back to summary

protected ASN1Set(ASN1Encodable[] array, boolean doSort)

Create a SET containing an array of objects.

Parameters

array:ASN1Encodable[]: an array of objects to make up the SET.
doSort:boolean: true if should be sorted DER style, false otherwise.

Method Detail

asn1Equals	back to summary
pack-priv boolean asn1Equals(ASN1Primitive o) Implements abstract org.bouncycastle.asn1.ASN1Primitive.asn1Equals. Doc from org.bouncycastle.asn1.ASN1Primitive.asn1Equals. Equality (similarity) comparison for two ASN1Primitive objects.

asn1Equals

back to summary

pack-priv boolean asn1Equals(ASN1Primitive o)

Implements abstract org.bouncycastle.asn1.ASN1Primitive.asn1Equals.

Doc from org.bouncycastle.asn1.ASN1Primitive.asn1Equals.

Equality (similarity) comparison for two ASN1Primitive objects.

encode	back to summary
pack-priv abstract void encode(ASN1OutputStream out) throws IOException Implements abstract org.bouncycastle.asn1.ASN1Primitive.encode.

getDEREncoded	back to summary
private byte[] getDEREncoded(ASN1Encodable obj)

getInstance	back to summary
public static ASN1Set getInstance(Object obj) return an ASN1Set from the given object. Parameters obj:Object the object we want converted. Returns:ASN1Set an ASN1Set instance, or null. Exceptions IllegalArgumentException: if the object cannot be converted.

getInstance

back to summary

public static ASN1Set getInstance(Object obj)

return an ASN1Set from the given object.

Parameters

obj:Object: the object we want converted.

Returns:ASN1Set

an ASN1Set instance, or null.

Exceptions

IllegalArgumentException:: if the object cannot be converted.

getInstance	back to summary
public static ASN1Set getInstance(ASN1TaggedObject obj, boolean explicit) Return an ASN1 set from a tagged object. There is a special case here, if an object appears to have been explicitly tagged on reading but we were expecting it to be implicitly tagged in the normal course of events it indicates that we lost the surrounding set - so we need to add it back (this will happen if the tagged object is a sequence that contains other sequences). If you are dealing with implicitly tagged sets you really should be using this method. Parameters obj:ASN1TaggedObject the tagged object. explicit:boolean true if the object is meant to be explicitly tagged false otherwise. Returns:ASN1Set an ASN1Set instance. Exceptions IllegalArgumentException: if the tagged object cannot be converted.

getInstance

back to summary

public static ASN1Set getInstance(ASN1TaggedObject obj, boolean explicit)

Return an ASN1 set from a tagged object. There is a special case here, if an object appears to have been explicitly tagged on reading but we were expecting it to be implicitly tagged in the normal course of events it indicates that we lost the surrounding set - so we need to add it back (this will happen if the tagged object is a sequence that contains other sequences). If you are dealing with implicitly tagged sets you really should be using this method.

Parameters

obj:ASN1TaggedObject: the tagged object.
explicit:boolean: true if the object is meant to be explicitly tagged false otherwise.

Returns:ASN1Set

an ASN1Set instance.

Exceptions

IllegalArgumentException:: if the tagged object cannot be converted.

getNext	back to summary
private ASN1Encodable getNext(Enumeration<E> e)

getObjectAt	back to summary
public ASN1Encodable getObjectAt(int index) return the object at the set position indicated by index. Parameters index:int the set number (starting at zero) of the object Returns:ASN1Encodable the object at the set position indicated by index.

getObjectAt

back to summary

public ASN1Encodable getObjectAt(int index)

return the object at the set position indicated by index.

Parameters

index:int: the set number (starting at zero) of the object

Returns:ASN1Encodable

the object at the set position indicated by index.

getObjects	back to summary
public Enumeration<E> getObjects()

hashCode back to summary

hashCode	back to summary
public int hashCode() Implements abstract org.bouncycastle.asn1.ASN1Primitive.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object

public int hashCode()

Implements abstract org.bouncycastle.asn1.ASN1Primitive.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int: a hash code value for this object

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.

iterator	back to summary
public Iterator<ASN1Encodable> iterator() Implements org.bouncycastle.util.Iterable.iterator. Doc from org.bouncycastle.util.Iterable.iterator. Returns an iterator over a set of elements of type T. Returns:Iterator<ASN1Encodable> an Iterator.

iterator

back to summary

public Iterator<ASN1Encodable> iterator()

Implements org.bouncycastle.util.Iterable.iterator.

Doc from org.bouncycastle.util.Iterable.iterator.

Returns an iterator over a set of elements of type T.

Returns:Iterator<ASN1Encodable>: an Iterator.

lessThanOrEqual	back to summary
private boolean lessThanOrEqual(byte[] a, byte[] b) return true if a <= b (arrays are assumed padded with zeros).

parser	back to summary
public ASN1SetParser parser()

size	back to summary
public int size() return the number of objects in this set. Returns:int the number of objects in this set.

size

back to summary

public int size()

return the number of objects in this set.

Returns:int: the number of objects in this set.

sort	back to summary
protected void sort()

toArray	back to summary
public ASN1Encodable[] toArray()

toDERObject back to summary

toDERObject	back to summary
pack-priv ASN1Primitive toDERObject() Overrides org.bouncycastle.asn1.ASN1Primitive.toDERObject. Change current SET object to be encoded as `DERSet`. This is part of Distinguished Encoding Rules form serialization. Returns:ASN1Primitive Doc from org.bouncycastle.asn1.ASN1Primitive.toDERObject. a DER version of this.

pack-priv ASN1Primitive toDERObject()

Overrides org.bouncycastle.asn1.ASN1Primitive.toDERObject.

Change current SET object to be encoded as DERSet. This is part of Distinguished Encoding Rules form serialization.

Returns:ASN1Primitive

Doc from org.bouncycastle.asn1.ASN1Primitive.toDERObject.

a DER version of this.

toDLObject back to summary

toDLObject	back to summary
pack-priv ASN1Primitive toDLObject() Overrides org.bouncycastle.asn1.ASN1Primitive.toDLObject. Change current SET object to be encoded as `DLSet`. This is part of Direct Length form serialization. Returns:ASN1Primitive Doc from org.bouncycastle.asn1.ASN1Primitive.toDLObject. a DL version of this.

pack-priv ASN1Primitive toDLObject()

Overrides org.bouncycastle.asn1.ASN1Primitive.toDLObject.

Change current SET object to be encoded as DLSet. This is part of Direct Length form serialization.

Returns:ASN1Primitive

Doc from org.bouncycastle.asn1.ASN1Primitive.toDLObject.

a DL version of this.

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. Returns:String a string representation of the object

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.

Returns:String: a string representation of the object

public abstract Class ASN1Set

X.690

8: Basic encoding rules

8.11 Encoding of a set value

8.12 Encoding of a set-of value

9: Canonical encoding rules

9.1 Length forms

9.3 Set components

10: Distinguished encoding rules

10.1 Length forms

10.3 Set components

11: Restrictions on BER employed by both CER and DER

11.5 Set and sequence components with default value

11.6 Set-of components

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail