/*
* Copyright (c) 1997, 2006, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package sun.security.pkcs;
import java.io.IOException;
import java.io.OutputStream;
import java.security.cert.CertificateException;
import java.util.Collection;
import java.util.Collections;
import java.util.Enumeration;
import java.util.Hashtable;
import sun.security.util.*;
/**
* This class defines the PKCS10 attributes for the request.
* The ASN.1 syntax for this is:
* <pre>
* Attributes ::= SET OF Attribute
* </pre>
*
* @author Amit Kapoor
* @author Hemma Prafullchandra
* @see PKCS10
* @see PKCS10Attribute
*/
public class PKCS10Attributes implements DerEncoder {
private Hashtable<String, PKCS10Attribute> map =
new Hashtable<String, PKCS10Attribute>(3);
/**
* Default constructor for the PKCS10 attribute.
*/
public PKCS10Attributes() { }
/**
* Create the object from the array of PKCS10Attribute objects.
*
* @param attrs the array of PKCS10Attribute objects.
*/
public PKCS10Attributes(PKCS10Attribute[] attrs) {
for (int i = 0; i < attrs.length; i++) {
map.put(attrs[i].getAttributeId().toString(), attrs[i]);
}
}
/**
* Create the object, decoding the values from the passed DER stream.
* The DER stream contains the SET OF Attribute.
*
* @param in the DerInputStream to read the attributes from.
* @exception IOException on decoding errors.
*/
public PKCS10Attributes(DerInputStream in) throws IOException {
DerValue[] attrs = in.getSet(3, true);
if (attrs == null)
throw new IOException("Illegal encoding of attributes");
for (int i = 0; i < attrs.length; i++) {
PKCS10Attribute attr = new PKCS10Attribute(attrs[i]);
map.put(attr.getAttributeId().toString(), attr);
}
}
/**
* Encode the attributes in DER form to the stream.
*
* @param out the OutputStream to marshal the contents to.
* @exception IOException on encoding errors.
*/
public void encode(OutputStream out) throws IOException {
derEncode(out);
}
/**
* Encode the attributes in DER form to the stream.
* Implements the <code>DerEncoder</code> interface.
*
* @param out the OutputStream to marshal the contents to.
* @exception IOException on encoding errors.
*/
public void derEncode(OutputStream out) throws IOException {
// first copy the elements into an array
Collection<PKCS10Attribute> allAttrs = map.values();
PKCS10Attribute[] attribs =
allAttrs.toArray(new PKCS10Attribute[map.size()]);
DerOutputStream attrOut = new DerOutputStream();
attrOut.putOrderedSetOf(DerValue.createTag(DerValue.TAG_CONTEXT,
true, (byte)0),
attribs);
out.write(attrOut.toByteArray());
}
/**
* Set the attribute value.
*/
public void setAttribute(String name, Object obj) {
if (obj instanceof PKCS10Attribute) {
map.put(name, (PKCS10Attribute)obj);
}
}
/**
* Get the attribute value.
*/
public Object getAttribute(String name) {
return map.get(name);
}
/**
* Delete the attribute value.
*/
public void deleteAttribute(String name) {
map.remove(name);
}
/**
* Return an enumeration of names of attributes existing within this
* attribute.
*/
public Enumeration<PKCS10Attribute> getElements() {
return (map.elements());
}
/**
* Return a Collection of attributes existing within this
* PKCS10Attributes object.
*/
public Collection<PKCS10Attribute> getAttributes() {
return (Collections.unmodifiableCollection(map.values()));
}
/**
* Compares this PKCS10Attributes for equality with the specified
* object. If the <code>other</code> object is an
* <code>instanceof</code> <code>PKCS10Attributes</code>, then
* all the entries are compared with the entries from this.
*
* @param other the object to test for equality with this PKCS10Attributes.
* @return true if all the entries match that of the Other,
* false otherwise.
*/
public boolean equals(Object other) {
if (this == other)
return true;
if (!(other instanceof PKCS10Attributes))
return false;
Collection<PKCS10Attribute> othersAttribs =
((PKCS10Attributes)other).getAttributes();
PKCS10Attribute[] attrs =
othersAttribs.toArray(new PKCS10Attribute[othersAttribs.size()]);
int len = attrs.length;
if (len != map.size())
return false;
PKCS10Attribute thisAttr, otherAttr;
String key = null;
for (int i=0; i < len; i++) {
otherAttr = attrs[i];
key = otherAttr.getAttributeId().toString();
if (key == null)
return false;
thisAttr = map.get(key);
if (thisAttr == null)
return false;
if (! thisAttr.equals(otherAttr))
return false;
}
return true;
}
/**
* Returns a hashcode value for this PKCS10Attributes.
*
* @return the hashcode value.
*/
public int hashCode() {
return map.hashCode();
}
/**
* Returns a string representation of this <tt>PKCS10Attributes</tt> object
* in the form of a set of entries, enclosed in braces and separated
* by the ASCII characters "<tt>,&nbsp;</tt>" (comma and space).
* <p>Overrides the <tt>toString</tt> method of <tt>Object</tt>.
*
* @return a string representation of this PKCS10Attributes.
*/
public String toString() {
String s = map.size() + "\n" + map.toString();
return s;
}
}