summaryrefslogtreecommitdiffstats
path: root/pki/base/util/src/netscape/security/x509/GenericValueConverter.java
blob: ba80bfc2e2ec14fec69cfca72912b2a1246bda66 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
// --- BEGIN COPYRIGHT BLOCK ---
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; version 2 of the License.
//
// This program 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 for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// (C) 2007 Red Hat, Inc.
// All rights reserved.
// --- END COPYRIGHT BLOCK ---
package netscape.security.x509;

import java.io.*;
import sun.io.CharToByteConverter;
import sun.io.ByteToCharConverter;

import netscape.security.util.DerValue;
import netscape.security.util.ASN1CharStrConvMap;

/**
 * A GenericValueConverter converts a string that is not associated with 
 * a particular attribute to a DER encoded ASN.1 character string type. 
 * Currently supports PrintableString, IA5String, BMPString T.61String and
 * Universal String.
 * 
 * <p>The conversion is done as follows. 
 * A CharToByteConverter is obtained for the all the character sets 
 * from the global default ASN1CharStrConvMap.
 * The CharToByteConverters are then used to convert the string to the 
 * smallest character set first -- printableString. 
 * If the string contains characters outside of that character set, 
 * it is converted to the next character set -- IA5String character set. 
 * If that is not enough it is converted to a BMPString, then  
 * Universal String which contains all characters.
 *
 * @author Lily Hsiao, Slava Galperin at Netscape Communications, Inc.
 * 
 */

public class GenericValueConverter implements AVAValueConverter
{
    public GenericValueConverter()
    {
    }

    /**
     * Converts a string to a DER encoded ASN.1 primtable string, defined here 
     * as a PrintableString, IA5String, T.61String, BMPString or  
     * UniversalString. The string is not expected to be encoded in any form.
     * 
     * <p>If a CharToByteConverter is not available for a character set that
     * is needed to convert the string, the string cannot be converted and 
     * an IOException is thrown. For example, if the string contains characters 
     * outside the PrintableString character and only a PrintableString 
     * CharToByteConverter is available then an IOException is thrown.
     * 
     * @param s 	A string representing a generic attribute string value.
     *
     * @return 		The DER value of the attribute.
     * 
     * @exception IOException	 if the string cannot be converted, such as 
     *				 when a CharToByteConverter needed is 
     *				 unavailable.
     */
    public DerValue getValue(String s)
	throws IOException
    {
	return getValue(s, null);
    }

    public DerValue getValue(String s, byte[] tags)
	throws IOException
    {
	// try to convert to printable, then t61 the universal -  
	// i.e. from minimal coverage to the broadest.
	int ret = -1;
	CharToByteConverter cbc;
	DerValue value;
	byte[] bbuf, derBuf;
	int i;

	if (tags == null || tags.length == 0)
		tags = DefEncodingTags;

	bbuf = new byte[4*s.length()];
	for (i = 0; i < tags.length; i++) 
	{
	    try {
		cbc = ASN1CharStrConvMap.getDefault().getCBC(tags[i]);
		if (cbc == null)
		    continue;
		ret = cbc.convert(s.toCharArray(), 0, s.length(), 
				  bbuf, 0, bbuf.length);
		break;
	    } 
	    catch (java.io.CharConversionException e) {
		continue;
	    } 
	    catch (InstantiationException e) {
		throw new IOException("Cannot instantiate CharToByteConverter");
	    } 
	    catch (IllegalAccessException e) {
		throw new IOException(
			"Illegal Access loading CharToByteConverter");
	    }
	}
	if (ret == -1) {
	    throw new IllegalArgumentException(
		"Cannot convert the string value to a ASN.1 type");
	}

	derBuf = new byte[ret];
	System.arraycopy(bbuf, 0, derBuf, 0, ret);
	return new DerValue(tags[i], derBuf);
    }

    /** 
     * Creates a DerValue from the byte array of BER encoded value.
     * 
     * NOTE: currently only supports DER encoding (a form of BER) on input .
     *
     * @param berStream    	Byte array of a BER encoded value.
     *         		
     * @return 			DerValue object.
     * 
     * @exception IOException	If the BER value cannot be converted to a 
     * 				valid Directory String DER value.
     */
    public DerValue getValue(byte[] berByteStream)
	throws IOException
    {
	// accepts any tag.
	DerValue value = new DerValue(berByteStream);
	return value;
    }

    /**
     * Converts a DerValue of ASN1 Character string type to a java string 
     * (the string is not encoded in any form).
     * 
     * @param avaValue 	A DerValue
     * @return 		A string representing the attribute value.
     * @exception IOException  	if a ByteToCharConverter needed for the 
     *				conversion is not available or if BER value 
     *				is not one of the ASN1 character string types
     *				here.
     */
    public String getAsString(DerValue avaValue) 
	throws IOException
    {
	return avaValue.getASN1CharString();
    }

    private static byte DefEncodingTags[] = { 
			DerValue.tag_PrintableString,
	                DerValue.tag_IA5String,
	                DerValue.tag_BMPString,
	                DerValue.tag_UTF8String,
	                DerValue.tag_T61String,
	                DerValue.tag_UniversalString
		     };
}