1b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallampackage org.bouncycastle.asn1;
2b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam
3b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallamimport java.io.IOException;
4b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam
5b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam/**
6b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam * DER VisibleString object.
7b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam */
8b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallampublic class DERVisibleString
9c37f4a04ef89e73a39a59f3c5a179af8c8ab5974Brian Carlstrom    extends ASN1Object
10b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    implements DERString
11b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam{
12b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    String  string;
13b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam
14b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    /**
15b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam     * return a Visible String from the passed in object.
16b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam     *
17b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam     * @exception IllegalArgumentException if the object cannot be converted.
18b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam     */
19b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    public static DERVisibleString getInstance(
20b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        Object  obj)
21b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    {
22b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        if (obj == null || obj instanceof DERVisibleString)
23b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        {
24b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam            return (DERVisibleString)obj;
25b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        }
26b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam
27b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        if (obj instanceof ASN1OctetString)
28b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        {
29b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam            return new DERVisibleString(((ASN1OctetString)obj).getOctets());
30b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        }
31b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam
32b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        if (obj instanceof ASN1TaggedObject)
33b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        {
34b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam            return getInstance(((ASN1TaggedObject)obj).getObject());
35b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        }
36b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam
37b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        throw new IllegalArgumentException("illegal object in getInstance: " + obj.getClass().getName());
38b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    }
39b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam
40b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    /**
41b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam     * return a Visible String from a tagged object.
42b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam     *
43b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam     * @param obj the tagged object holding the object we want
44b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam     * @param explicit true if the object is meant to be explicitly
45b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam     *              tagged false otherwise.
46b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam     * @exception IllegalArgumentException if the tagged object cannot
47b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam     *               be converted.
48b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam     */
49b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    public static DERVisibleString getInstance(
50b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        ASN1TaggedObject obj,
51b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        boolean          explicit)
52b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    {
53b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        return getInstance(obj.getObject());
54b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    }
55b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam
56b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    /**
57b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam     * basic constructor - byte encoded string.
58b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam     */
59b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    public DERVisibleString(
60b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        byte[]   string)
61b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    {
62b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        char[]  cs = new char[string.length];
63b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam
64b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        for (int i = 0; i != cs.length; i++)
65b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        {
66b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam            cs[i] = (char)(string[i] & 0xff);
67b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        }
68b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam
69b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        this.string = new String(cs);
70b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    }
71b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam
72b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    /**
73b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam     * basic constructor
74b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam     */
75b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    public DERVisibleString(
76b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        String   string)
77b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    {
78b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        this.string = string;
79b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    }
80b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam
81b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    public String getString()
82b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    {
83b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        return string;
84b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    }
85b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam
86c37f4a04ef89e73a39a59f3c5a179af8c8ab5974Brian Carlstrom    public String toString()
87c37f4a04ef89e73a39a59f3c5a179af8c8ab5974Brian Carlstrom    {
88c37f4a04ef89e73a39a59f3c5a179af8c8ab5974Brian Carlstrom        return string;
89c37f4a04ef89e73a39a59f3c5a179af8c8ab5974Brian Carlstrom    }
90c37f4a04ef89e73a39a59f3c5a179af8c8ab5974Brian Carlstrom
91b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    public byte[] getOctets()
92b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    {
93b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        char[]  cs = string.toCharArray();
94b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        byte[]  bs = new byte[cs.length];
95b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam
96b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        for (int i = 0; i != cs.length; i++)
97b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        {
98b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam            bs[i] = (byte)cs[i];
99b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        }
100b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam
101b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        return bs;
102b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    }
103b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam
104b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    void encode(
105b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        DEROutputStream  out)
106b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        throws IOException
107b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    {
108b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        out.writeEncoded(VISIBLE_STRING, this.getOctets());
109b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    }
110b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam
111c37f4a04ef89e73a39a59f3c5a179af8c8ab5974Brian Carlstrom    boolean asn1Equals(
112c37f4a04ef89e73a39a59f3c5a179af8c8ab5974Brian Carlstrom        DERObject  o)
113b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    {
114c37f4a04ef89e73a39a59f3c5a179af8c8ab5974Brian Carlstrom        if (!(o instanceof DERVisibleString))
115b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        {
116b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam            return false;
117b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        }
118b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam
119b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        return this.getString().equals(((DERVisibleString)o).getString());
120b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    }
121b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam
122b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    public int hashCode()
123b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    {
124b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam        return this.getString().hashCode();
125b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam    }
126b61a96e7ef1a78acf013bbf08fe537e5b5f129caPeter Hallam}
127