CertificateV2 (jndn 0.22 API)

java.lang.Object
- net.named_data.jndn.Data
- - net.named_data.jndn.security.v2.CertificateV2

All Implemented Interfaces:

SignatureHolder, ChangeCountable
```
public class CertificateV2
extends Data
```
CertificateV2 represents a certificate following the certificate format naming convention. Overview of the NDN certificate format: CertificateV2 ::= DATA-TLV TLV-LENGTH Name (= /{NameSpace}/KEY/[KeyId]/[IssuerId]/[Version]) MetaInfo (.ContentType = KEY) Content (= X509PublicKeyContent) SignatureInfo (= CertificateV2SignatureInfo) SignatureValue X509PublicKeyContent ::= CONTENT-TLV TLV-LENGTH BYTE+ (= public key bits in PKCS#8 format) CertificateV2SignatureInfo ::= SIGNATURE-INFO-TYPE TLV-LENGTH SignatureType KeyLocator ValidityPeriod ... optional critical or non-critical extension blocks ... An example of NDN certificate name: /edu/ucla/cs/yingdi/KEY/%03%CD...%F1/%9F%D3...%B7/%FD%d2...%8E \_________________/ \___________/ \___________/\___________/ Certificate Namespace Key Id Issuer Id Version (Identity) \__________________________________/ Key Name Notes: - `Key Id` is an opaque name component to identify the instance of the public key for the certificate namespace. The value of `Key ID` is controlled by the namespace owner. The library includes helpers for generating key IDs using an 8-byte random number, SHA-256 digest of the public key, timestamp, and the specified numerical identifiers. - `Issuer Id` is sn opaque name component to identify the issuer of the certificate. The value is controlled by the issuer. The library includes helpers to set issuer the ID to an 8-byte random number, SHA-256 digest of the issuer's public key, and the specified numerical identifiers. - `Key Name` is a logical name of the key used for management purposes. the Key Name includes the certificate namespace, keyword `KEY`, and `KeyId` components. See https://github.com/named-data/ndn-cxx/blob/master/docs/specs/certificate-format.rst

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CertificateV2.Error` A CertificateV2.Error extends Exception and represents errors for not complying with the certificate format.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ISSUER_ID_OFFSET`
`static Name.Component`	`KEY_COMPONENT`
`static int`	`KEY_COMPONENT_OFFSET`
`static int`	`KEY_ID_OFFSET`
`static int`	`MIN_CERT_NAME_LENGTH`
`static int`	`MIN_KEY_NAME_LENGTH`
`static int`	`VERSION_OFFSET`

Constructor Summary

Constructors
Constructor and Description
`CertificateV2()` Create a CertificateV2 with content type KEY and default or unspecified values.
`CertificateV2(Data data)` Create a CertificateV2 from the content in the Data packet.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Name`	`extractIdentityFromCertName(Name certificateName)` Extract the identity namespace from certificateName.
`static Name`	`extractKeyNameFromCertName(Name certificateName)` Extract key name from certificateName.
`Name`	`getIdentity()` Get the identity name from the certificate name.
`Name.Component`	`getIssuerId()` Get the issuer ID component from the certificate name.
`Name.Component`	`getKeyId()` Get the key ID component from the certificate name.
`Name`	`getKeyName()` Get key name from the certificate name.
`Blob`	`getPublicKey()` Get the public key DER encoding.
`ValidityPeriod`	`getValidityPeriod()` Get the certificate validity period from the SignatureInfo.
`boolean`	`isValid()` Check if the current time falls within the validity period.
`boolean`	`isValid(double time)` Check if the time falls within the validity period.
`static boolean`	`isValidName(Name certificateName)` Check if certificateName follows the naming convention for a certificate.
`void`	`printCertificate(StringBuffer result)` Write a string representation of this certificate to result.
`String`	`toString()` Use printCertificate to return a string representation of this certificate.
`void`	`wireDecode(Blob input, WireFormat wireFormat)` Override to call the base class wireDecode then check the certificate format.

Methods inherited from class net.named_data.jndn.Data
getChangeCount, getCongestionMark, getContent, getDefaultWireEncoding, getFullName, getFullName, getIncomingFaceId, getMetaInfo, getName, getSignature, setContent, setLpPacket, setMetaInfo, setName, setSignature, wireDecode, wireDecode, wireDecode, wireEncode, wireEncode

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - VERSION_OFFSET
```
public static final int VERSION_OFFSET
```
    See Also:
    
    Constant Field Values
  - ISSUER_ID_OFFSET
```
public static final int ISSUER_ID_OFFSET
```
    See Also:
    
    Constant Field Values
  - KEY_ID_OFFSET
```
public static final int KEY_ID_OFFSET
```
    See Also:
    
    Constant Field Values
  - KEY_COMPONENT_OFFSET
```
public static final int KEY_COMPONENT_OFFSET
```
    See Also:
    
    Constant Field Values
  - MIN_CERT_NAME_LENGTH
```
public static final int MIN_CERT_NAME_LENGTH
```
    See Also:
    
    Constant Field Values
  - MIN_KEY_NAME_LENGTH
```
public static final int MIN_KEY_NAME_LENGTH
```
    See Also:
    
    Constant Field Values
  - KEY_COMPONENT
```
public static final Name.Component KEY_COMPONENT
```
- Constructor Detail
  - CertificateV2
```
public CertificateV2()
```
    Create a CertificateV2 with content type KEY and default or unspecified values.
  - CertificateV2
```
public CertificateV2(Data data)
              throws CertificateV2.Error
```
    Create a CertificateV2 from the content in the Data packet.
    
    Parameters:
    
    data - The data packet with the content to copy.
    
    Throws:
    
    CertificateV2.Error - If data does not follow the certificate format.
- Method Detail
  - getKeyName
```
public final Name getKeyName()
```
    Get key name from the certificate name.
    
    Returns:
    
    The key name as a new Name.
  - getIdentity
```
public final Name getIdentity()
```
    Get the identity name from the certificate name.
    
    Returns:
    
    The identity name as a new Name.
  - getKeyId
```
public final Name.Component getKeyId()
```
    Get the key ID component from the certificate name.
    
    Returns:
    
    The key ID name component.
  - getIssuerId
```
public final Name.Component getIssuerId()
```
    Get the issuer ID component from the certificate name.
    
    Returns:
    
    The issuer ID component.
  - getPublicKey
```
public final Blob getPublicKey()
                        throws CertificateV2.Error
```
    Get the public key DER encoding.
    
    Returns:
    
    The DER encoding Blob.
    
    Throws:
    
    CertificateV2.Error - If the public key is not set.
  - getValidityPeriod
```
public final ValidityPeriod getValidityPeriod()
```
    Get the certificate validity period from the SignatureInfo.
    
    Returns:
    
    The ValidityPeriod object.
    
    Throws:
    
    IllegalArgumentException - If the SignatureInfo doesn't have a ValidityPeriod.
  - isValid
```
public final boolean isValid(double time)
```
    Check if the time falls within the validity period.
    
    Parameters:
    
    time - The time to check as milliseconds since Jan 1, 1970 UTC.
    
    Returns:
    
    True if the beginning of the validity period is less than or equal to time and time is less than or equal to the end of the validity period.
    
    Throws:
    
    IllegalArgumentException - If the SignatureInfo doesn't have a ValidityPeriod.
  - isValid
```
public final boolean isValid()
```
    Check if the current time falls within the validity period.
    
    Returns:
    
    True if the beginning of the validity period is less than or equal to the current time and the current time is less than or equal to the end of the validity period.
    
    Throws:
    
    IllegalArgumentException - If the SignatureInfo doesn't have a ValidityPeriod.
  - printCertificate
```
public void printCertificate(StringBuffer result)
```
    Write a string representation of this certificate to result.
    
    Parameters:
    
    result - The StringBuffer to write to.
  - wireDecode
```
public void wireDecode(Blob input,
                       WireFormat wireFormat)
                throws EncodingException
```
    Override to call the base class wireDecode then check the certificate format.
    
    Overrides:
    
    wireDecode in class Data
    
    Parameters:
    
    input - The input byte array to be decoded as an immutable Blob.
    
    wireFormat - A WireFormat object used to decode the input.
    
    Throws:
    
    EncodingException - For invalid encoding.
  - toString
```
public String toString()
```
    Use printCertificate to return a string representation of this certificate.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    The string representation of this certificate.
  - isValidName
```
public static boolean isValidName(Name certificateName)
```
    Check if certificateName follows the naming convention for a certificate.
    
    Parameters:
    
    certificateName - The name of the certificate.
    
    Returns:
    
    True if certificateName follows the naming convention.
  - extractIdentityFromCertName
```
public static Name extractIdentityFromCertName(Name certificateName)
```
    Extract the identity namespace from certificateName.
    
    Parameters:
    
    certificateName - The name of the certificate.
    
    Returns:
    
    The identity namespace as a new Name.
  - extractKeyNameFromCertName
```
public static Name extractKeyNameFromCertName(Name certificateName)
```
    Extract key name from certificateName.
    
    Parameters:
    
    certificateName - The name of the certificate.
    
    Returns:
    
    The key name as a new Name.

Class CertificateV2

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.named_data.jndn.Data

Methods inherited from class java.lang.Object

Field Detail

VERSION_OFFSET

ISSUER_ID_OFFSET

KEY_ID_OFFSET

KEY_COMPONENT_OFFSET

MIN_CERT_NAME_LENGTH

MIN_KEY_NAME_LENGTH

KEY_COMPONENT

Constructor Detail

CertificateV2

CertificateV2

Method Detail

getKeyName

getIdentity

getKeyId

getIssuerId

getPublicKey

getValidityPeriod

isValid

isValid

printCertificate

wireDecode

toString

isValidName

extractIdentityFromCertName

extractKeyNameFromCertName