iaik.asn1.structures
Class GeneralSubtree

java.lang.Object
  |
  +--iaik.asn1.structures.GeneralSubtree

public class GeneralSubtree

extends java.lang.Object

implements ASN1Type

An implementation of the ASN.1 structure GeneralSubtree as used within the NameConstraints extension.

The NameConstraints is used within CA certifcates for indicating a name space within which all subject names in subsequent certificates in a certification path must be located (see PKIX internet draft draft-ietf-pkix-ipki-part1-07.txt). Restrictions may apply to the subject distinguished name or subject alternative names. Restrictions are defined in terms of permitted or excluded name subtrees. Any name matching a restriction in the excludedSubtrees field is invalid regardless of information appearing in the permittedSubtrees. Both, excludedSubtrees and permittedSubtrees are defined as GeneralSubtrees structures consisting of a sequence of GeneralSubtree components, as implemented by this class:

 NameConstraints ::= SEQUENCE {
   permittedSubtrees       [0]     GeneralSubtrees OPTIONAL,
   excludedSubtrees        [1]     GeneralSubtrees OPTIONAL }
 

 GeneralSubtrees ::= SEQUENCE SIZE (1..MAX) OF GeneralSubtree
 GeneralSubtree ::= SEQUENCE {
   base                    GeneralName,
   minimum         [0]     BaseDistance DEFAULT 0,
   maximum         [1]     BaseDistance OPTIONAL }
 

 BaseDistance ::= INTEGER (0..MAX)
 

 GeneralName ::= CHOICE {
          otherName                       [0]     OtherName,
          rfc822Name                      [1]     IA5String,
          dNSName                         [2]     IA5String,
          x400Address                     [3]     ORAddress,
          directoryName                   [4]     Name,
          ediPartyName                    [5]     EDIPartyName,
          uniformResourceIdentifier       [6]     IA5String,
          iPAddress                       [7]     OCTET STRING,
          registeredID                    [8]     OBJECT IDENTIFIER}
 

When creating a GeneralSubtree object to be used for the NameConstraints extension, specify the base immediately, and subsequently use the setMinimum and setMaximum methods for setting the base distances, e.g.:

 GeneralSubtree generalSubtree = new GeneralSubtree(new GeneralName(GeneralName.rfc822Name, "*.tu-graz.ac.at"));
 generalSubtree.setMinimum(1); 
 generalSubtree.setMaximum(3);
 

See Also:

NameConstraints, GeneralName

Constructor Summary

GeneralSubtree()
Default constructor.

GeneralSubtree(GeneralName base)
Creates a new GeneralSubrtree from a base representing some GeneralName.

Method Summary

void	decode(ASN1Object obj) Decodes a GeneralSubtree from the given ASN1Object.
GeneralName	getBase() Returns the base GeneralName.
int	getMaximum() Returns the maximum base distance or -1 if not set.
int	getMinimum() Returns the minimum base distance.
void	setMaximum(int maximum) Sets the maximum base distance.
void	setMinimum(int minimum) Sets the minimum base distance.
ASN1Object	toASN1Object() Returns this GeneralSubtree as (SEQUENCE) ASN1Object.
java.lang.String	toString() Returns a string that represents the contents of this GeneralSubtree.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneralSubtree

public GeneralSubtree()

Default constructor.

The minimum base distance per default is set to 0, and the maximum base distance is set to -1 indicating that the maximum value is not set. For explicitly setting the base distance values, use the setMinimum and setMaximum methods.

GeneralSubtree

public GeneralSubtree(GeneralName base)

Creates a new GeneralSubrtree from a base representing some GeneralName.

For Instance:

GeneralSubtree generalSubtree = new GeneralSubtree(new GeneralName(GeneralName.rfc822Name, "*.tu-graz.ac.at"));

The minimum base distance per default is set to 0, and the maximum base distance is set to -1 indicating that the maximum value is not set. For explicitly setting the base distance values, use the setMinimum and setMaximum methods.

Parameters:

base - the base GeneralName

Method Detail

toASN1Object

public ASN1Object toASN1Object()
                        throws CodingException

Returns this GeneralSubtree as (SEQUENCE) ASN1Object.

Specified by:

toASN1Object in interface ASN1Type

Returns:

this GeneralSubtree as ASN1Object

Throws:

CodingException - if the ASN1Object cannot be created

decode

public void decode(ASN1Object obj)
            throws CodingException

Decodes a GeneralSubtree from the given ASN1Object.

The given ASN1Object is parsed for the base GeneralName, minimum and maximum BaseDistance values.

Specified by:

decode in interface ASN1Type

Parameters:

obj - the GeneralSubtree as ASN1Object

Throws:

CodingException - if a parsing error occurs

setMinimum

public void setMinimum(int minimum)

Sets the minimum base distance.

Parameters:

minimum - the minimum base distance as int

setMaximum

public void setMaximum(int maximum)

Sets the maximum base distance.

Parameters:

maximum - the maximum base distance as int

getBase

public GeneralName getBase()

Returns the base GeneralName.

Returns:

the base

getMinimum

public int getMinimum()

Returns the minimum base distance.

Returns:

the minimum base distance

getMaximum

public int getMaximum()

Returns the maximum base distance or -1 if not set.

Returns:

the maximum base distance or -1 if not set

toString

public java.lang.String toString()

Returns a string that represents the contents of this GeneralSubtree.

Overrides:

toString in class java.lang.Object

Returns:

the string representation