com.tencent.kona.sun.security.x509

Class IPAddressName

java.lang.Object

com.tencent.kona.sun.security.x509.IPAddressName

All Implemented Interfaces:

com.tencent.kona.sun.security.util.DerEncoder, GeneralNameInterface

public class IPAddressName
extends java.lang.Object
implements GeneralNameInterface

This class implements the IPAddressName as required by the GeneralNames ASN.1 object. Both IPv4 and IPv6 addresses are supported using the formats specified in IETF PKIX RFC 5280.

[RFC 5280 4.2.1.6 Subject Alternative Name] When the subjectAltName extension contains an iPAddress, the address MUST be stored in the octet string in "network byte order", as specified in [RFC791]. The least significant bit (LSB) of each octet is the LSB of the corresponding byte in the network address. For IP version 4, as specified in [RFC791], the octet string MUST contain exactly four octets. For IP version 6, as specified in [RFC 2460], the octet string MUST contain exactly sixteen octets.

[RFC 5280 4.2.1.10 Name Constraints] The syntax of iPAddress MUST be as described in Section 4.2.1.6 with the following additions specifically for name constraints. For IPv4 addresses, the iPAddress field of GeneralName MUST contain eight (8) octets, encoded in the style of RFC 4632 (CIDR) to represent an address range [RFC 4632]. For IPv6 addresses, the iPAddress field MUST contain 32 octets similarly encoded. For example, a name constraint for "class C" subnet 192.0.2.0 is represented as the octets C0 00 02 00 FF FF FF 00, representing the CIDR notation 192.0.2.0/24 (mask 255.255.255.0).

See Also:

GeneralName, GeneralNameInterface, GeneralNames

Field Summary

Fields inherited from interface com.tencent.kona.sun.security.x509.GeneralNameInterface

NAME_ANY, NAME_DIFF_TYPE, NAME_DIRECTORY, NAME_DNS, NAME_EDI, NAME_IP, NAME_MATCH, NAME_NARROWS, NAME_OID, NAME_RFC822, NAME_SAME_TYPE, NAME_URI, NAME_WIDENS, NAME_X400

Constructor Summary

Constructors

Constructor and Description
IPAddressName(byte[] address) Create the IPAddressName object with the specified octets.
IPAddressName(com.tencent.kona.sun.security.util.DerValue derValue) Create the IPAddressName object from the passed encoded Der value.
IPAddressName(java.lang.String name) Create an IPAddressName from a String.

Method Summary

Modifier and Type	Method and Description
int	constrains(GeneralNameInterface inputName) Return type of constraint inputName places on this name: NAME_DIFF_TYPE = -1: input name is different type from name (i.e.
void	encode(com.tencent.kona.sun.security.util.DerOutputStream out) Encode the IPAddress name into the DerOutputStream.
boolean	equals(java.lang.Object obj) Compares this name with another, for equality.
byte[]	getBytes() Returns this IPAddress name as a byte array.
java.lang.String	getName() Return a standard String representation of IPAddress.
int	getType() Return the type of the GeneralName.
int	hashCode() Returns the hash code value for this object.
int	subtreeDepth() Return subtree depth of this name for purposes of determining NameConstraints minimum and maximum bounds and for calculating path lengths in name subtrees.
java.lang.String	toString() Return a printable string of IPaddress

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IPAddressName

public IPAddressName(com.tencent.kona.sun.security.util.DerValue derValue)
              throws java.io.IOException

Create the IPAddressName object from the passed encoded Der value.

Parameters:

derValue - the encoded DER IPAddressName.

Throws:

java.io.IOException - on error.

IPAddressName

public IPAddressName(byte[] address)
              throws java.io.IOException

Create the IPAddressName object with the specified octets.

Parameters:

address - the IP address

Throws:

java.io.IOException - if address is not a valid IPv4 or IPv6 address

IPAddressName

public IPAddressName(java.lang.String name)
              throws java.io.IOException

Create an IPAddressName from a String. [IETF RFC1338 Supernetting & IETF RFC1519 Classless Inter-Domain Routing (CIDR)] For IPv4 addresses, the forms are "b1.b2.b3.b4" or "b1.b2.b3.b4/m1.m2.m3.m4", where b1 - b4 are decimal byte values 0-255 and m1 - m4 are decimal mask values 0 - 255.

[IETF RFC2373 IP Version 6 Addressing Architecture] For IPv6 addresses, the forms are "a1:a2:...:a8" or "a1:a2:...:a8/n", where a1-a8 are hexadecimal values representing the eight 16-bit pieces of the address. If /n is used, n is a decimal number indicating how many of the leftmost contiguous bits of the address comprise the prefix for this subnet. Internally, a mask value is created using the prefix length.

Parameters:

name - String form of IPAddressName

Throws:

java.io.IOException - if name can not be converted to a valid IPv4 or IPv6 address

Method Detail

getType

public int getType()

Return the type of the GeneralName.

Specified by:

getType in interface GeneralNameInterface

encode

public void encode(com.tencent.kona.sun.security.util.DerOutputStream out)

Encode the IPAddress name into the DerOutputStream.

Specified by:

encode in interface com.tencent.kona.sun.security.util.DerEncoder

Parameters:

out - the DER stream to encode the IPAddressName to.

toString

public java.lang.String toString()

Return a printable string of IPaddress

Overrides:

toString in class java.lang.Object

getName

public java.lang.String getName()
                         throws java.io.IOException

Return a standard String representation of IPAddress. See IPAddressName(String) for the formats used for IPv4 and IPv6 addresses.

Throws:

java.io.IOException - if the IPAddress cannot be converted to a String

getBytes

public byte[] getBytes()

Returns this IPAddress name as a byte array.

equals

public boolean equals(java.lang.Object obj)

Compares this name with another, for equality.

Overrides:

equals in class java.lang.Object

Returns:

true iff the names are identical.

hashCode

public int hashCode()

Returns the hash code value for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.

constrains

public int constrains(GeneralNameInterface inputName)
               throws java.lang.UnsupportedOperationException

Return type of constraint inputName places on this name:

• NAME_DIFF_TYPE = -1: input name is different type from name (i.e. does not constrain).
• NAME_MATCH = 0: input name matches name.
• NAME_NARROWS = 1: input name narrows name (is lower in the naming subtree)
• NAME_WIDENS = 2: input name widens name (is higher in the naming subtree)
• NAME_SAME_TYPE = 3: input name does not match or narrow name, but is same type.

. These results are used in checking NameConstraints during certification path verification.

[RFC 5280 4.2.1.10 Name Constraints] The syntax of iPAddress MUST be as described in Section 4.2.1.6 with the following additions specifically for name constraints. For IPv4 addresses, the iPAddress field of GeneralName MUST contain eight (8) octets, encoded in the style of RFC 4632 (CIDR) to represent an address range [RFC 4632]. For IPv6 addresses, the iPAddress field MUST contain 32 octets similarly encoded. For example, a name constraint for "class C" subnet 192.0.2.0 is represented as the octets C0 00 02 00 FF FF FF 00, representing the CIDR notation 192.0.2.0/24 (mask 255.255.255.0).

Specified by:

constrains in interface GeneralNameInterface

Parameters:

inputName - to be checked for being constrained

Returns:

constraint type above

Throws:

java.lang.UnsupportedOperationException - if name is not exact match, but narrowing and widening are not supported for this name type.

subtreeDepth

public int subtreeDepth()
                 throws java.lang.UnsupportedOperationException

Return subtree depth of this name for purposes of determining NameConstraints minimum and maximum bounds and for calculating path lengths in name subtrees.

Specified by:

subtreeDepth in interface GeneralNameInterface

Returns:

distance of name from root

Throws:

java.lang.UnsupportedOperationException - if not supported for this name type