Java Doc for X509Certificate.java in  » 6.0-JDK-Core » security » javax » security » cert » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » security » javax.security.cert 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   javax.security.cert.Certificate
      javax.security.cert.X509Certificate

X509Certificate
abstract public class X509Certificate extends Certificate (Code)
Abstract class for X.509 v1 certificates. This provides a standard way to access all the version 1 attributes of an X.509 certificate. Attributes that are specific to X.509 v2 or v3 are not available through this interface. Future API evolution will provide full access to complete X.509 v3 attributes.

The basic X.509 format was defined by ISO/IEC and ANSI X9 and is described below in ASN.1:

 Certificate  ::=  SEQUENCE  {
 tbsCertificate       TBSCertificate,
 signatureAlgorithm   AlgorithmIdentifier,
 signature            BIT STRING  }
 

These certificates are widely used to support authentication and other functionality in Internet security systems. Common applications include Privacy Enhanced Mail (PEM), Transport Layer Security (SSL), code signing for trusted software distribution, and Secure Electronic Transactions (SET).

These certificates are managed and vouched for by Certificate Authorities (CAs). CAs are services which create certificates by placing data in the X.509 standard format and then digitally signing that data. CAs act as trusted third parties, making introductions between principals who have no direct knowledge of each other. CA certificates are either signed by themselves, or by some other CA such as a "root" CA.

The ASN.1 definition of tbsCertificate is:

 TBSCertificate  ::=  SEQUENCE  {
 version         [0]  EXPLICIT Version DEFAULT v1,
 serialNumber         CertificateSerialNumber,
 signature            AlgorithmIdentifier,
 issuer               Name,
 validity             Validity,
 subject              Name,
 subjectPublicKeyInfo SubjectPublicKeyInfo,
 }
 

Here is sample code to instantiate an X.509 certificate:

 
 InputStream inStream = new FileInputStream("fileName-of-cert");
 X509Certificate cert = X509Certificate.getInstance(inStream);
 inStream.close();
 
OR
 byte[] certData = <certificate read from a file, say>
 X509Certificate cert = X509Certificate.getInstance(certData);
 

In either case, the code that instantiates an X.509 certificate consults the Java security properties file to locate the actual implementation or instantiates a default implementation.

The Java security properties file is located in the file named <JAVA_HOME>/lib/security/java.security. <JAVA_HOME> refers to the value of the java.home system property, and specifies the directory where the JRE is installed. In the Security properties file, a default implementation for X.509 v1 may be given such as:

 cert.provider.x509v1=com.sun.security.cert.internal.x509.X509V1CertImpl
 

The value of this cert.provider.x509v1 property has to be changed to instatiate another implementation. If this security property is not set, a default implementation will be used. Currently, due to possible security restrictions on access to Security properties, this value is looked up and cached at class initialization time and will fallback on a default implementation if the Security property is not accessible.

Note: The classes in the package javax.security.cert exist for compatibility with earlier versions of the Java Secure Sockets Extension (JSSE). New applications should instead use the standard Java SE certificate classes located in java.security.cert.


author:
   Hemma Prafullchandra
version:
   1.38
since:
   1.4
See Also:   Certificate
See Also:   java.security.cert.X509Extension




Method Summary
abstract public  voidcheckValidity()
     Checks that the certificate is currently valid.
abstract public  voidcheckValidity(Date date)
     Checks that the specified date is within the certificate's validity period.
final public static  X509CertificategetInstance(InputStream inStream)
     Instantiates an X509Certificate object, and initializes it with the data read from the input stream inStream. The implementation (X509Certificate is an abstract class) is provided by the class specified as the value of the cert.provider.x509v1 property in the security properties file.

Note: Only one DER-encoded certificate is expected to be in the input stream. Also, all X509Certificate subclasses must provide a constructor of the form:

 public <subClass>(InputStream inStream) ...
 

Parameters:
  inStream - an input stream with the data to be read toinitialize the certificate.
final public static  X509CertificategetInstance(byte[] certData)
     Instantiates an X509Certificate object, and initializes it with the specified byte array. The implementation (X509Certificate is an abstract class) is provided by the class specified as the value of the cert.provider.x509v1 property in the security properties file.

Note: All X509Certificate subclasses must provide a constructor of the form:

 public <subClass>(InputStream inStream) ...
 

Parameters:
  certData - a byte array containing the DER-encodedcertificate.
abstract public  PrincipalgetIssuerDN()
     Gets the issuer (issuer distinguished name) value from the certificate.
abstract public  DategetNotAfter()
     Gets the notAfter date from the validity period of the certificate.
abstract public  DategetNotBefore()
     Gets the notBefore date from the validity period of the certificate.
abstract public  BigIntegergetSerialNumber()
     Gets the serialNumber value from the certificate. The serial number is an integer assigned by the certification authority to each certificate.
abstract public  StringgetSigAlgName()
     Gets the signature algorithm name for the certificate signature algorithm.
abstract public  StringgetSigAlgOID()
     Gets the signature algorithm OID string from the certificate.
abstract public  byte[]getSigAlgParams()
     Gets the DER-encoded signature algorithm parameters from this certificate's signature algorithm.
abstract public  PrincipalgetSubjectDN()
     Gets the subject (subject distinguished name) value from the certificate.
abstract public  intgetVersion()
     Gets the version (version number) value from the certificate.



Method Detail
checkValidity
abstract public void checkValidity() throws CertificateExpiredException, CertificateNotYetValidException(Code)
Checks that the certificate is currently valid. It is if the current date and time are within the validity period given in the certificate.

The validity period consists of two date/time values: the first and last dates (and times) on which the certificate is valid. It is defined in ASN.1 as:

 validity             Validity

Validity ::= SEQUENCE { notBefore CertificateValidityDate, notAfter CertificateValidityDate }

CertificateValidityDate ::= CHOICE { utcTime UTCTime, generalTime GeneralizedTime }


exception:
  CertificateExpiredException - if the certificate has expired.
exception:
  CertificateNotYetValidException - if the certificate is notyet valid.



checkValidity
abstract public void checkValidity(Date date) throws CertificateExpiredException, CertificateNotYetValidException(Code)
Checks that the specified date is within the certificate's validity period. In other words, this determines whether the certificate would be valid at the specified date/time.
Parameters:
  date - the Date to check against to see if this certificateis valid at that date/time.
exception:
  CertificateExpiredException - if the certificate has expiredwith respect to the date supplied.
exception:
  CertificateNotYetValidException - if the certificate is notyet valid with respect to the date supplied.
See Also:   X509Certificate.checkValidity()



getInstance
final public static X509Certificate getInstance(InputStream inStream) throws CertificateException(Code)
Instantiates an X509Certificate object, and initializes it with the data read from the input stream inStream. The implementation (X509Certificate is an abstract class) is provided by the class specified as the value of the cert.provider.x509v1 property in the security properties file.

Note: Only one DER-encoded certificate is expected to be in the input stream. Also, all X509Certificate subclasses must provide a constructor of the form:

 public <subClass>(InputStream inStream) ...
 

Parameters:
  inStream - an input stream with the data to be read toinitialize the certificate. an X509Certificate object initialized with the datafrom the input stream.
exception:
  CertificateException - if a class initializationor certificate parsing error occurs.



getInstance
final public static X509Certificate getInstance(byte[] certData) throws CertificateException(Code)
Instantiates an X509Certificate object, and initializes it with the specified byte array. The implementation (X509Certificate is an abstract class) is provided by the class specified as the value of the cert.provider.x509v1 property in the security properties file.

Note: All X509Certificate subclasses must provide a constructor of the form:

 public <subClass>(InputStream inStream) ...
 

Parameters:
  certData - a byte array containing the DER-encodedcertificate. an X509Certificate object initialized with the datafrom certData.
exception:
  CertificateException - if a class initializationor certificate parsing error occurs.



getIssuerDN
abstract public Principal getIssuerDN()(Code)
Gets the issuer (issuer distinguished name) value from the certificate. The issuer name identifies the entity that signed (and issued) the certificate.

The issuer name field contains an X.500 distinguished name (DN). The ASN.1 definition for this is:

 issuer    Name

Name ::= CHOICE { RDNSequence } RDNSequence ::= SEQUENCE OF RelativeDistinguishedName RelativeDistinguishedName ::= SET OF AttributeValueAssertion AttributeValueAssertion ::= SEQUENCE { AttributeType, AttributeValue } AttributeType ::= OBJECT IDENTIFIER AttributeValue ::= ANY

The Name describes a hierarchical name composed of attributes, such as country name, and corresponding values, such as US. The type of the AttributeValue component is determined by the AttributeType; in general it will be a directoryString. A directoryString is usually one of PrintableString, TeletexString or UniversalString. a Principal whose name is the issuer distinguished name.



getNotAfter
abstract public Date getNotAfter()(Code)
Gets the notAfter date from the validity period of the certificate. See getNotBefore for relevant ASN.1 definitions. the end date of the validity period.
See Also:   X509Certificate.checkValidity()



getNotBefore
abstract public Date getNotBefore()(Code)
Gets the notBefore date from the validity period of the certificate. The relevant ASN.1 definitions are:
 validity             Validity

Validity ::= SEQUENCE { notBefore CertificateValidityDate, notAfter CertificateValidityDate }

CertificateValidityDate ::= CHOICE { utcTime UTCTime, generalTime GeneralizedTime }

the start date of the validity period.
See Also:   X509Certificate.checkValidity()



getSerialNumber
abstract public BigInteger getSerialNumber()(Code)
Gets the serialNumber value from the certificate. The serial number is an integer assigned by the certification authority to each certificate. It must be unique for each certificate issued by a given CA (i.e., the issuer name and serial number identify a unique certificate). The ASN.1 definition for this is:
 serialNumber     CertificateSerialNumber

CertificateSerialNumber ::= INTEGER

the serial number.



getSigAlgName
abstract public String getSigAlgName()(Code)
Gets the signature algorithm name for the certificate signature algorithm. An example is the string "SHA-1/DSA". The ASN.1 definition for this is:
 signatureAlgorithm   AlgorithmIdentifier

AlgorithmIdentifier ::= SEQUENCE { algorithm OBJECT IDENTIFIER, parameters ANY DEFINED BY algorithm OPTIONAL } -- contains a value of the type -- registered for use with the -- algorithm object identifier value

The algorithm name is determined from the algorithm OID string. the signature algorithm name.




getSigAlgOID
abstract public String getSigAlgOID()(Code)
Gets the signature algorithm OID string from the certificate. An OID is represented by a set of positive whole numbers separated by periods. For example, the string "1.2.840.10040.4.3" identifies the SHA-1 with DSA signature algorithm, as per the PKIX part I.

See getSigAlgName for relevant ASN.1 definitions. the signature algorithm OID string.




getSigAlgParams
abstract public byte[] getSigAlgParams()(Code)
Gets the DER-encoded signature algorithm parameters from this certificate's signature algorithm. In most cases, the signature algorithm parameters are null; the parameters are usually supplied with the certificate's public key.

See getSigAlgName for relevant ASN.1 definitions. the DER-encoded signature algorithm parameters, ornull if no parameters are present.




getSubjectDN
abstract public Principal getSubjectDN()(Code)
Gets the subject (subject distinguished name) value from the certificate. The ASN.1 definition for this is:
 subject    Name
 

See getIssuerDN for Name and other relevant definitions. a Principal whose name is the subject name.
See Also:   X509Certificate.getIssuerDN()




getVersion
abstract public int getVersion()(Code)
Gets the version (version number) value from the certificate. The ASN.1 definition for this is:
 version         [0]  EXPLICIT Version DEFAULT v1

Version ::= INTEGER { v1(0), v2(1), v3(2) }

the version number from the ASN.1 encoding, i.e. 0, 1 or 2.



Methods inherited from javax.security.cert.Certificate
public boolean equals(Object other)(Code)(Java Doc)
abstract public byte[] getEncoded() throws CertificateEncodingException(Code)(Java Doc)
abstract public PublicKey getPublicKey()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
abstract public String toString()(Code)(Java Doc)
abstract public void verify(PublicKey key) throws CertificateException, NoSuchAlgorithmException, InvalidKeyException, NoSuchProviderException, SignatureException(Code)(Java Doc)
abstract public void verify(PublicKey key, String sigProvider) throws CertificateException, NoSuchAlgorithmException, InvalidKeyException, NoSuchProviderException, SignatureException(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.