libjava/java/security/cert/X509Extension.java

   1 /* X509Extension.java --- X.509 Extension
   2    Copyright (C) 1999 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package java.security.cert;
  40 import java.util.Set;
  41
  42 /**
  43         Public interface for the X.509 Extension.
  44
  45         This is used for X.509 v3 Certificates and CRL v2 (Certificate
  46         Revocation Lists) for managing attributes assoicated with
  47         Certificates, for managing the hierarchy of certificates,
  48         and for managing the distribution of CRL. This extension
  49         format is used to define private extensions.
  50
  51         Each extensions for a certificate or CRL must be marked
  52         either critical or non-critical. If the certificate/CRL
  53         system encounters a critical extension not recognized then
  54         it must reject the certificate. A non-critical extension
  55         may be just ignored if not recognized.
  56
  57
  58         The ASN.1 definition for this class is:
  59
  60          Extensions  ::=  SEQUENCE SIZE (1..MAX) OF Extension
  61
  62          Extension  ::=  SEQUENCE  {
  63              extnId        OBJECT IDENTIFIER,
  64              critical      BOOLEAN DEFAULT FALSE,
  65              extnValue     OCTET STRING
  66                            -- contains a DER encoding of a value
  67                            -- of the type registered for use with
  68                            -- the extnId object identifier value
  69          }
  70
  71         @author Mark Benvenuto
  72
  73         @since JDK 1.2
  74 */
  75 public interface X509Extension
  76 {
  77
  78   /**
  79      Returns true if the certificate contains a critical extension
  80      that is not supported.
  81
  82      @return true if has unsupported extension, false otherwise
  83   */
  84   boolean hasUnsupportedCriticalExtension();
  85
  86   /**
  87      Returns a set of the CRITICAL extension OIDs from the
  88      certificate/CRL that the object implementing this interface
  89      manages.
  90
  91      @return A Set containing the OIDs. If there are no CRITICAL
  92      extensions or extensions at all this returns null.
  93   */
  94   Set getCriticalExtensionOIDs();
  95
  96   /**
  97      Returns a set of the NON-CRITICAL extension OIDs from the
  98      certificate/CRL that the object implementing this interface
  99      manages.
 100
 101      @return A Set containing the OIDs. If there are no NON-CRITICAL
 102      extensions or extensions at all this returns null.
 103   */
 104   Set getNonCriticalExtensionOIDs();
 105
 106   /**
 107      Returns the DER encoded OCTET string for the specified
 108      extension value identified by a OID. The OID is a string
 109      of number separated by periods. Ex: 12.23.45.67
 110   */
 111   byte[] getExtensionValue(String oid);
 112
 113 }