0N/A/*
2362N/A * Copyright (c) 1997, 2006, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
2362N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2362N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
0N/A */
0N/A
0N/Apackage sun.security.x509;
0N/A
0N/Aimport java.io.IOException;
0N/Aimport java.io.OutputStream;
0N/Aimport java.util.Enumeration;
0N/A
0N/Aimport sun.security.util.*;
0N/A
0N/A/**
0N/A * Represent the Key Usage Extension.
0N/A *
0N/A * <p>This extension, if present, defines the purpose (e.g., encipherment,
0N/A * signature, certificate signing) of the key contained in the certificate.
0N/A * The usage restriction might be employed when a multipurpose key is to be
0N/A * restricted (e.g., when an RSA key should be used only for signing or only
0N/A * for key encipherment).
0N/A *
0N/A * @author Amit Kapoor
0N/A * @author Hemma Prafullchandra
0N/A * @see Extension
0N/A * @see CertAttrSet
0N/A */
0N/Apublic class KeyUsageExtension extends Extension
0N/Aimplements CertAttrSet<String> {
0N/A
0N/A /**
0N/A * Identifier for this attribute, to be used with the
0N/A * get, set, delete methods of Certificate, x509 type.
0N/A */
0N/A public static final String IDENT = "x509.info.extensions.KeyUsage";
0N/A /**
0N/A * Attribute names.
0N/A */
0N/A public static final String NAME = "KeyUsage";
0N/A public static final String DIGITAL_SIGNATURE = "digital_signature";
0N/A public static final String NON_REPUDIATION = "non_repudiation";
0N/A public static final String KEY_ENCIPHERMENT = "key_encipherment";
0N/A public static final String DATA_ENCIPHERMENT = "data_encipherment";
0N/A public static final String KEY_AGREEMENT = "key_agreement";
0N/A public static final String KEY_CERTSIGN = "key_certsign";
0N/A public static final String CRL_SIGN = "crl_sign";
0N/A public static final String ENCIPHER_ONLY = "encipher_only";
0N/A public static final String DECIPHER_ONLY = "decipher_only";
0N/A
0N/A // Private data members
0N/A private boolean[] bitString;
0N/A
0N/A // Encode this extension value
0N/A private void encodeThis() throws IOException {
0N/A DerOutputStream os = new DerOutputStream();
0N/A os.putTruncatedUnalignedBitString(new BitArray(this.bitString));
0N/A this.extensionValue = os.toByteArray();
0N/A }
0N/A
0N/A /**
0N/A * Check if bit is set.
0N/A *
0N/A * @param position the position in the bit string to check.
0N/A */
0N/A private boolean isSet(int position) {
0N/A return bitString[position];
0N/A }
0N/A
0N/A /**
0N/A * Set the bit at the specified position.
0N/A */
0N/A private void set(int position, boolean val) {
0N/A // enlarge bitString if necessary
0N/A if (position >= bitString.length) {
0N/A boolean[] tmp = new boolean[position+1];
0N/A System.arraycopy(bitString, 0, tmp, 0, bitString.length);
0N/A bitString = tmp;
0N/A }
0N/A bitString[position] = val;
0N/A }
0N/A
0N/A /**
0N/A * Create a KeyUsageExtension with the passed bit settings. The criticality
0N/A * is set to true.
0N/A *
0N/A * @param bitString the bits to be set for the extension.
0N/A */
0N/A public KeyUsageExtension(byte[] bitString) throws IOException {
0N/A this.bitString =
0N/A new BitArray(bitString.length*8,bitString).toBooleanArray();
0N/A this.extensionId = PKIXExtensions.KeyUsage_Id;
0N/A this.critical = true;
0N/A encodeThis();
0N/A }
0N/A
0N/A /**
0N/A * Create a KeyUsageExtension with the passed bit settings. The criticality
0N/A * is set to true.
0N/A *
0N/A * @param bitString the bits to be set for the extension.
0N/A */
0N/A public KeyUsageExtension(boolean[] bitString) throws IOException {
0N/A this.bitString = bitString;
0N/A this.extensionId = PKIXExtensions.KeyUsage_Id;
0N/A this.critical = true;
0N/A encodeThis();
0N/A }
0N/A
0N/A /**
0N/A * Create a KeyUsageExtension with the passed bit settings. The criticality
0N/A * is set to true.
0N/A *
0N/A * @param bitString the bits to be set for the extension.
0N/A */
0N/A public KeyUsageExtension(BitArray bitString) throws IOException {
0N/A this.bitString = bitString.toBooleanArray();
0N/A this.extensionId = PKIXExtensions.KeyUsage_Id;
0N/A this.critical = true;
0N/A encodeThis();
0N/A }
0N/A
0N/A /**
0N/A * Create the extension from the passed DER encoded value of the same.
0N/A * The DER encoded value may be wrapped in an OCTET STRING.
0N/A *
0N/A * @param critical true if the extension is to be treated as critical.
0N/A * @param value an array of DER encoded bytes of the actual value (possibly
0N/A * wrapped in an OCTET STRING).
0N/A * @exception ClassCastException if value is not an array of bytes
0N/A * @exception IOException on error.
0N/A */
0N/A public KeyUsageExtension(Boolean critical, Object value)
0N/A throws IOException {
0N/A this.extensionId = PKIXExtensions.KeyUsage_Id;
0N/A this.critical = critical.booleanValue();
0N/A /*
0N/A * The following check should be activated again after
0N/A * the PKIX profiling work becomes standard and the check
0N/A * is not a barrier to interoperability !
0N/A * if (!this.critical) {
0N/A * throw new IOException("KeyUsageExtension not marked critical,"
0N/A * + " invalid profile.");
0N/A * }
0N/A */
0N/A byte[] extValue = (byte[]) value;
0N/A if (extValue[0] == DerValue.tag_OctetString) {
0N/A this.extensionValue = new DerValue(extValue).getOctetString();
0N/A } else {
0N/A this.extensionValue = extValue;
0N/A }
0N/A DerValue val = new DerValue(this.extensionValue);
0N/A this.bitString = val.getUnalignedBitString().toBooleanArray();
0N/A }
0N/A
0N/A /**
0N/A * Create a default key usage.
0N/A */
0N/A public KeyUsageExtension() {
0N/A extensionId = PKIXExtensions.KeyUsage_Id;
0N/A critical = true;
0N/A bitString = new boolean[0];
0N/A }
0N/A
0N/A /**
0N/A * Set the attribute value.
0N/A */
0N/A public void set(String name, Object obj) throws IOException {
0N/A if (!(obj instanceof Boolean)) {
0N/A throw new IOException("Attribute must be of type Boolean.");
0N/A }
0N/A boolean val = ((Boolean)obj).booleanValue();
0N/A if (name.equalsIgnoreCase(DIGITAL_SIGNATURE)) {
0N/A set(0,val);
0N/A } else if (name.equalsIgnoreCase(NON_REPUDIATION)) {
0N/A set(1,val);
0N/A } else if (name.equalsIgnoreCase(KEY_ENCIPHERMENT)) {
0N/A set(2,val);
0N/A } else if (name.equalsIgnoreCase(DATA_ENCIPHERMENT)) {
0N/A set(3,val);
0N/A } else if (name.equalsIgnoreCase(KEY_AGREEMENT)) {
0N/A set(4,val);
0N/A } else if (name.equalsIgnoreCase(KEY_CERTSIGN)) {
0N/A set(5,val);
0N/A } else if (name.equalsIgnoreCase(CRL_SIGN)) {
0N/A set(6,val);
0N/A } else if (name.equalsIgnoreCase(ENCIPHER_ONLY)) {
0N/A set(7,val);
0N/A } else if (name.equalsIgnoreCase(DECIPHER_ONLY)) {
0N/A set(8,val);
0N/A } else {
0N/A throw new IOException("Attribute name not recognized by"
0N/A + " CertAttrSet:KeyUsage.");
0N/A }
0N/A encodeThis();
0N/A }
0N/A
0N/A /**
0N/A * Get the attribute value.
0N/A */
0N/A public Object get(String name) throws IOException {
0N/A if (name.equalsIgnoreCase(DIGITAL_SIGNATURE)) {
0N/A return Boolean.valueOf(isSet(0));
0N/A } else if (name.equalsIgnoreCase(NON_REPUDIATION)) {
0N/A return Boolean.valueOf(isSet(1));
0N/A } else if (name.equalsIgnoreCase(KEY_ENCIPHERMENT)) {
0N/A return Boolean.valueOf(isSet(2));
0N/A } else if (name.equalsIgnoreCase(DATA_ENCIPHERMENT)) {
0N/A return Boolean.valueOf(isSet(3));
0N/A } else if (name.equalsIgnoreCase(KEY_AGREEMENT)) {
0N/A return Boolean.valueOf(isSet(4));
0N/A } else if (name.equalsIgnoreCase(KEY_CERTSIGN)) {
0N/A return Boolean.valueOf(isSet(5));
0N/A } else if (name.equalsIgnoreCase(CRL_SIGN)) {
0N/A return Boolean.valueOf(isSet(6));
0N/A } else if (name.equalsIgnoreCase(ENCIPHER_ONLY)) {
0N/A return Boolean.valueOf(isSet(7));
0N/A } else if (name.equalsIgnoreCase(DECIPHER_ONLY)) {
0N/A return Boolean.valueOf(isSet(8));
0N/A } else {
0N/A throw new IOException("Attribute name not recognized by"
0N/A + " CertAttrSet:KeyUsage.");
0N/A }
0N/A }
0N/A
0N/A /**
0N/A * Delete the attribute value.
0N/A */
0N/A public void delete(String name) throws IOException {
0N/A if (name.equalsIgnoreCase(DIGITAL_SIGNATURE)) {
0N/A set(0,false);
0N/A } else if (name.equalsIgnoreCase(NON_REPUDIATION)) {
0N/A set(1,false);
0N/A } else if (name.equalsIgnoreCase(KEY_ENCIPHERMENT)) {
0N/A set(2,false);
0N/A } else if (name.equalsIgnoreCase(DATA_ENCIPHERMENT)) {
0N/A set(3,false);
0N/A } else if (name.equalsIgnoreCase(KEY_AGREEMENT)) {
0N/A set(4,false);
0N/A } else if (name.equalsIgnoreCase(KEY_CERTSIGN)) {
0N/A set(5,false);
0N/A } else if (name.equalsIgnoreCase(CRL_SIGN)) {
0N/A set(6,false);
0N/A } else if (name.equalsIgnoreCase(ENCIPHER_ONLY)) {
0N/A set(7,false);
0N/A } else if (name.equalsIgnoreCase(DECIPHER_ONLY)) {
0N/A set(8,false);
0N/A } else {
0N/A throw new IOException("Attribute name not recognized by"
0N/A + " CertAttrSet:KeyUsage.");
0N/A }
0N/A encodeThis();
0N/A }
0N/A
0N/A /**
0N/A * Returns a printable representation of the KeyUsage.
0N/A */
0N/A public String toString() {
0N/A String s = super.toString() + "KeyUsage [\n";
0N/A
0N/A try {
0N/A if (isSet(0)) {
0N/A s += " DigitalSignature\n";
0N/A }
0N/A if (isSet(1)) {
0N/A s += " Non_repudiation\n";
0N/A }
0N/A if (isSet(2)) {
0N/A s += " Key_Encipherment\n";
0N/A }
0N/A if (isSet(3)) {
0N/A s += " Data_Encipherment\n";
0N/A }
0N/A if (isSet(4)) {
0N/A s += " Key_Agreement\n";
0N/A }
0N/A if (isSet(5)) {
0N/A s += " Key_CertSign\n";
0N/A }
0N/A if (isSet(6)) {
0N/A s += " Crl_Sign\n";
0N/A }
0N/A if (isSet(7)) {
0N/A s += " Encipher_Only\n";
0N/A }
0N/A if (isSet(8)) {
0N/A s += " Decipher_Only\n";
0N/A }
0N/A } catch (ArrayIndexOutOfBoundsException ex) {}
0N/A
0N/A s += "]\n";
0N/A
0N/A return (s);
0N/A }
0N/A
0N/A /**
0N/A * Write the extension to the DerOutputStream.
0N/A *
0N/A * @param out the DerOutputStream to write the extension to.
0N/A * @exception IOException on encoding errors.
0N/A */
0N/A public void encode(OutputStream out) throws IOException {
0N/A DerOutputStream tmp = new DerOutputStream();
0N/A
0N/A if (this.extensionValue == null) {
0N/A this.extensionId = PKIXExtensions.KeyUsage_Id;
0N/A this.critical = true;
0N/A encodeThis();
0N/A }
0N/A super.encode(tmp);
0N/A out.write(tmp.toByteArray());
0N/A }
0N/A
0N/A /**
0N/A * Return an enumeration of names of attributes existing within this
0N/A * attribute.
0N/A */
0N/A public Enumeration<String> getElements() {
0N/A AttributeNameEnumeration elements = new AttributeNameEnumeration();
0N/A elements.addElement(DIGITAL_SIGNATURE);
0N/A elements.addElement(NON_REPUDIATION);
0N/A elements.addElement(KEY_ENCIPHERMENT);
0N/A elements.addElement(DATA_ENCIPHERMENT);
0N/A elements.addElement(KEY_AGREEMENT);
0N/A elements.addElement(KEY_CERTSIGN);
0N/A elements.addElement(CRL_SIGN);
0N/A elements.addElement(ENCIPHER_ONLY);
0N/A elements.addElement(DECIPHER_ONLY);
0N/A
0N/A return (elements.elements());
0N/A }
0N/A
0N/A
0N/A public boolean[] getBits() {
0N/A return bitString.clone();
0N/A }
0N/A
0N/A /**
0N/A * Return the name of this attribute.
0N/A */
0N/A public String getName() {
0N/A return (NAME);
0N/A }
0N/A}