summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/cmscore/extensions/KeyUsage.java
blob: bba95949da0277de79c61b230fee5abd54229c3a (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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
// --- 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 com.netscape.cmscore.extensions;

import java.io.IOException;

import netscape.security.util.DerOutputStream;
import netscape.security.util.ObjectIdentifier;
import netscape.security.x509.Extension;
import netscape.security.x509.KeyUsageExtension;
import netscape.security.x509.PKIXExtensions;

import com.netscape.certsrv.apps.CMS;
import com.netscape.certsrv.base.EBaseException;
import com.netscape.certsrv.base.IArgBlock;
import com.netscape.certsrv.base.IConfigStore;
import com.netscape.certsrv.base.ISubsystem;
import com.netscape.certsrv.extensions.EExtensionsException;
import com.netscape.certsrv.extensions.ICMSExtension;
import com.netscape.certsrv.logging.ILogger;
import com.netscape.cmscore.util.Debug;

public class KeyUsage implements ICMSExtension {
    private final static String NAME = "KeyUsageExtension";
    private final static ObjectIdentifier OID = PKIXExtensions.KeyUsage_Id;

    private IConfigStore mConfig = null;
    private boolean mSetDefault = false;

    private ILogger mLogger;

    public KeyUsage(boolean setDefault) {
        mSetDefault = setDefault;
        mLogger = CMS.getLogger();
    }

    public void init(ISubsystem owner, IConfigStore config)
            throws EBaseException {
        // nothing to do here.
        mConfig = config;
    }

    public String getName() {
        return NAME;
    }

    public ObjectIdentifier getOID() {
        return OID;
    }

    protected static final boolean[] DEF_BITS =
            new boolean[KeyUsageExtension.NBITS];

    static {
        // set default bits used when request missing key usage info.
        DEF_BITS[KeyUsageExtension.DIGITAL_SIGNATURE_BIT] = true;
        DEF_BITS[KeyUsageExtension.NON_REPUDIATION_BIT] = false;
        DEF_BITS[KeyUsageExtension.KEY_ENCIPHERMENT_BIT] = true;
        DEF_BITS[KeyUsageExtension.DATA_ENCIPHERMENT_BIT] = true;
        DEF_BITS[KeyUsageExtension.KEY_AGREEMENT_BIT] = false;
        DEF_BITS[KeyUsageExtension.KEY_CERTSIGN_BIT] = false;
        DEF_BITS[KeyUsageExtension.CRL_SIGN_BIT] = false;
        DEF_BITS[KeyUsageExtension.ENCIPHER_ONLY_BIT] = false;
        DEF_BITS[KeyUsageExtension.DECIPHER_ONLY_BIT] = false;
    }

    private static boolean getBoolean(Object value) {
        String val = (String) value;

        if (val != null &&
                (val.equalsIgnoreCase("true") || val.equalsIgnoreCase("on")))
            return true;
        else
            return false;
    }

    public Extension getExtension(IArgBlock args) throws EBaseException {
        boolean[] bits = new boolean[KeyUsageExtension.NBITS];
        Object[] values = new Object[KeyUsageExtension.NBITS];
        int bit;

        // check if no bits are set. If not set default bits.
        bit = KeyUsageExtension.DIGITAL_SIGNATURE_BIT;
        values[bit] = args.get(KeyUsageExtension.names[bit]);
        bit = KeyUsageExtension.NON_REPUDIATION_BIT;
        values[bit] = args.get(KeyUsageExtension.names[bit]);
        bit = KeyUsageExtension.KEY_ENCIPHERMENT_BIT;
        values[bit] = args.get(KeyUsageExtension.names[bit]);
        bit = KeyUsageExtension.DATA_ENCIPHERMENT_BIT;
        values[bit] = args.get(KeyUsageExtension.names[bit]);
        bit = KeyUsageExtension.KEY_AGREEMENT_BIT;
        values[bit] = args.get(KeyUsageExtension.names[bit]);
        bit = KeyUsageExtension.KEY_CERTSIGN_BIT;
        values[bit] = args.get(KeyUsageExtension.names[bit]);
        bit = KeyUsageExtension.CRL_SIGN_BIT;
        values[bit] = args.get(KeyUsageExtension.names[bit]);
        bit = KeyUsageExtension.ENCIPHER_ONLY_BIT;
        values[bit] = args.get(KeyUsageExtension.names[bit]);
        bit = KeyUsageExtension.DECIPHER_ONLY_BIT;
        values[bit] = args.get(KeyUsageExtension.names[bit]);

        // if nothing is set, make one with default set of bits.
        int i;

        for (i = 0; i < KeyUsageExtension.NBITS; i++) {
            if (values[i] != null && (values[i] instanceof String))
                break;
        }
        if (i == KeyUsageExtension.NBITS && mSetDefault) {
            // no key usage extension parameters are requested. set default.
            CMS.debug(
                    "No Key usage bits requested. Setting default.");
            bits = DEF_BITS;
        } else {
            bit = KeyUsageExtension.DIGITAL_SIGNATURE_BIT;
            bits[bit] = getBoolean(values[bit]);
            if (Debug.ON)
                Debug.trace("Requested key usage bit " + bit + " " + bits[bit]);
            bit = KeyUsageExtension.NON_REPUDIATION_BIT;
            bits[bit] = getBoolean(values[bit]);
            if (Debug.ON)
                Debug.trace("Requested key usage bit " + bit + " " + bits[bit]);
            bit = KeyUsageExtension.KEY_ENCIPHERMENT_BIT;
            bits[bit] = getBoolean(values[bit]);
            if (Debug.ON)
                Debug.trace("Requested key usage bit " + bit + " " + bits[bit]);
            bit = KeyUsageExtension.DATA_ENCIPHERMENT_BIT;
            bits[bit] = getBoolean(values[bit]);
            if (Debug.ON)
                Debug.trace("Requested key usage bit " + bit + " " + bits[bit]);
            bit = KeyUsageExtension.KEY_AGREEMENT_BIT;
            bits[bit] = getBoolean(values[bit]);
            if (Debug.ON)
                Debug.trace("Requested key usage bit " + bit + " " + bits[bit]);
            bit = KeyUsageExtension.KEY_CERTSIGN_BIT;
            bits[bit] = getBoolean(values[bit]);
            if (Debug.ON)
                Debug.trace("Requested key usage bit " + bit + " " + bits[bit]);
            bit = KeyUsageExtension.CRL_SIGN_BIT;
            bits[bit] = getBoolean(values[bit]);
            if (Debug.ON)
                Debug.trace("Requested key usage bit " + bit + " " + bits[bit]);
            bit = KeyUsageExtension.ENCIPHER_ONLY_BIT;
            bits[bit] = getBoolean(values[bit]);
            if (Debug.ON)
                Debug.trace("Requested key usage bit " + bit + " " + bits[bit]);
            bit = KeyUsageExtension.DECIPHER_ONLY_BIT;
            bits[bit] = getBoolean(values[bit]);
            if (Debug.ON)
                Debug.trace("Requested key usage bit " + bit + " " + bits[bit]);
        }

        try {
            int j = 0;

            for (j = 0; j < bits.length; j++) {
                if (bits[j])
                    break;
            }
            if (j == bits.length) {
                if (!mSetDefault)
                    return null;
                else
                    bits = DEF_BITS;
            }
            return new KeyUsageExtension(bits);
        } catch (IOException e) {
            throw new EExtensionsException(
                    CMS.getUserMessage("CMS_EXTENSION_CREATING_EXT_ERROR", NAME));
        }
    }

    public IArgBlock getFormParams(Extension extension)
            throws EBaseException {
        KeyUsageExtension ext = null;

        if (!extension.getExtensionId().equals(PKIXExtensions.KeyUsage_Id)) {
            return null;
        }
        if (extension instanceof KeyUsageExtension) {
            ext = (KeyUsageExtension) extension;
        } else {
            try {
                DerOutputStream der = new DerOutputStream();
                byte[] value = extension.getExtensionValue();

                ext = new KeyUsageExtension(new Boolean(true), value);
            } catch (IOException e) {
                return null;
            }
        }

        IArgBlock params = CMS.createArgBlock();
        boolean[] bits = ext.getBits();

        params.set(KeyUsageExtension.DIGITAL_SIGNATURE,
                String.valueOf(bits[KeyUsageExtension.DIGITAL_SIGNATURE_BIT]));
        params.set(KeyUsageExtension.NON_REPUDIATION,
                String.valueOf(bits[KeyUsageExtension.NON_REPUDIATION_BIT]));
        params.set(KeyUsageExtension.KEY_ENCIPHERMENT,
                String.valueOf(bits[KeyUsageExtension.KEY_ENCIPHERMENT_BIT]));
        params.set(KeyUsageExtension.DATA_ENCIPHERMENT,
                String.valueOf(bits[KeyUsageExtension.DATA_ENCIPHERMENT_BIT]));
        params.set(KeyUsageExtension.KEY_AGREEMENT,
                String.valueOf(bits[KeyUsageExtension.KEY_AGREEMENT_BIT]));
        params.set(KeyUsageExtension.KEY_CERTSIGN,
                String.valueOf(bits[KeyUsageExtension.KEY_CERTSIGN_BIT]));
        params.set(KeyUsageExtension.CRL_SIGN,
                String.valueOf(bits[KeyUsageExtension.CRL_SIGN_BIT]));
        params.set(KeyUsageExtension.ENCIPHER_ONLY,
                String.valueOf(bits[KeyUsageExtension.ENCIPHER_ONLY_BIT]));
        params.set(KeyUsageExtension.DECIPHER_ONLY,
                String.valueOf(bits[KeyUsageExtension.DECIPHER_ONLY_BIT]));
        return params;
    }

}