summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/cms/publish/mappers/MapDNPattern.java
blob: 2785cc6cda6ecc7c5d55b320ed6cbded99bfc5f6 (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
// --- 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.cms.publish.mappers;


import com.netscape.certsrv.logging.*;
import java.security.*;
import java.security.cert.*;
import netscape.security.x509.*;
import netscape.security.util.*;
import com.netscape.certsrv.base.*;
import com.netscape.certsrv.apps.*;
import netscape.ldap.*;
import java.io.*;
import java.util.*;
import com.netscape.certsrv.request.IRequest;
import com.netscape.certsrv.ldap.*;
import com.netscape.certsrv.publish.*;


/**
 * class for parsing a DN pattern used to construct a ldap dn from 
 * request attributes and cert subject name.<p>
 * 
 * dnpattern is a string representing a ldap dn pattern to formulate from 
 * the certificate subject name attributes and request attributes . 
 * If empty or not set, the certificate subject name 
 * will be used as the ldap dn. <p>
 * 
 * The syntax is 
 * <pre>
 *		dnPattern := rdnPattern *[ "," rdnPattern ]
 *		rdnPattern := avaPattern *[ "+" avaPattern ]
 * 		avaPattern := name "=" value | 
 *				      name "=" "$subj" "." attrName [ "." attrNumber ] | 
 *				      name "=" "$req" "." attrName [ "." attrNumber ] | 
 *	    		 	  "$rdn" "." number
 * </pre>
 * <pre>
 * Example1: <i>cn=Certificate Manager,ou=people,o=mcom.com</i>
 * cert subject name: dn:  CN=Certificate Manager, OU=people, O=mcom.com
 * request attributes: uid: cmanager 
 * <p>
 * The dn formulated will be : <br>
 *     CN=Certificate Manager, OU=people, O=mcom.com
 * <p>
 * note: Subordinate ca enrollment will use ca mapper. Use predicate
 * to distinguish the ca itself and the subordinates.
 *
 * Example2: <i>UID=$req.HTTP_PARAMS.uid, OU=$subj.ou, O=people, , O=mcom.com</i>
 * cert subject name: dn:  UID=jjames, OU=IS, O=people, , O=mcom.com
 * request attributes: uid: cmanager 
 * <p>
 * The dn formulated will be : <br>
 *     UID=jjames, OU=IS, OU=people, O=mcom.com
 * <p>	
 *     UID = the 'uid' attribute value in the request. <br>
 *     OU = the 'ou' value in the cert subject name.  <br>
 *     O = the string people, mcom.com. <br>
 * <p>
 * </pre>
 * If an request attribute or subject DN component does not exist,
 * the attribute is skipped. There is potential risk that a wrong dn
 * will be mapped into.
 *
 * @version $Revision$, $Date$
 */
public class MapDNPattern {

    /* the list of request attriubutes to retrieve*/
    protected String[] mReqAttrs = null;

    /* the list of cert attriubutes to retrieve*/
    protected String[] mCertAttrs = null;

    /* rdn patterns */
    protected MapRDNPattern[] mRDNPatterns = null;

    /* original pattern string */
    protected String mPatternString = null;

    protected String mTestDN = null;

    /** 
     * Construct a DN pattern by parsing a pattern string.
     * @param pattern the DN pattern
     * @exception EBaseException If parsing error occurs. 
     */
    public MapDNPattern(String pattern)
        throws ELdapException {
        if (pattern == null || pattern.equals("")) {
            CMS.debug(
                "MapDNPattern: null pattern");			
        } else {
            mPatternString = pattern;
            PushbackReader in = new PushbackReader(new StringReader(pattern));

            parse(in);
        }
    }

    public MapDNPattern(PushbackReader in) 
        throws ELdapException {
        parse(in);
    }

    private void parse(PushbackReader in)
        throws ELdapException {
        Vector rdnPatterns = new Vector();
        MapRDNPattern rdnPattern = null;
        int lastChar = -1;

        do {
            rdnPattern = new MapRDNPattern(in);
            rdnPatterns.addElement(rdnPattern);
            try {
                lastChar = in.read();
            } catch (IOException e) {
                throw new ELdapException(
                        CMS.getUserMessage("CMS_LDAP_INTERNAL_ERROR", e.toString()));
            }
        }
        while (lastChar == ',');

        mRDNPatterns = new MapRDNPattern[rdnPatterns.size()];
        rdnPatterns.copyInto(mRDNPatterns);

        Vector reqAttrs = new Vector();

        for (int i = 0; i < mRDNPatterns.length; i++) {
            String[] rdnAttrs = mRDNPatterns[i].getReqAttrs();

            if (rdnAttrs != null && rdnAttrs.length > 0) 
                for (int j = 0; j < rdnAttrs.length; j++) 
                    reqAttrs.addElement(rdnAttrs[j]);
        }
        mReqAttrs = new String[reqAttrs.size()];
        reqAttrs.copyInto(mReqAttrs);

        Vector certAttrs = new Vector();

        for (int i = 0; i < mRDNPatterns.length; i++) {
            String[] rdnAttrs = mRDNPatterns[i].getCertAttrs();

            if (rdnAttrs != null && rdnAttrs.length > 0) 
                for (int j = 0; j < rdnAttrs.length; j++) 
                    certAttrs.addElement(rdnAttrs[j]);
        }
        mCertAttrs = new String[certAttrs.size()];
        certAttrs.copyInto(mCertAttrs);
    }

    /**
     * Form a Ldap v3 DN string from a request and a cert subject name.
     * @param req the request for (un)publish
     * @param subject the subjectDN of the certificate
     * @return Ldap v3 DN string to use for base ldap search. 
     */
    public String formDN(IRequest req, X500Name subject, CertificateExtensions ext)
        throws ELdapException {
        StringBuffer formedDN = new StringBuffer();

        for (int i = 0; i < mRDNPatterns.length; i++) {
            if (mTestDN != null)
                mRDNPatterns[i].mTestDN = mTestDN;
            String rdn = mRDNPatterns[i].formRDN(req, subject, ext);

            if (rdn != null && rdn.length() != 0) {
                    if (formedDN.length() != 0) 
                        formedDN.append(",");
                    formedDN.append(rdn);
            } else {
		throw new ELdapException("pattern not matched");
            }
        }
        return formedDN.toString();
    }

    public String[] getReqAttrs() {
        return (String[]) mReqAttrs.clone();
    }

    public String[] getCertAttrs() {
        return (String[]) mCertAttrs.clone();
    }
}