// --- 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.authentication; import java.io.IOException; import java.io.PushbackReader; import java.io.StringReader; import java.util.Vector; import netscape.ldap.LDAPEntry; import com.netscape.certsrv.authentication.EAuthException; import com.netscape.certsrv.base.EBaseException; /** * class for parsing a DN pattern used to construct a certificate * subject name from ldap attributes and dn. *
* * dnpattern is a string representing a subject name pattern to formulate from the directory attributes and entry dn. If * empty or not set, the ldap entry DN will be used as the certificate subject name. *
* * The syntax is * *
* dnPattern := rdnPattern *[ "," rdnPattern ] * rdnPattern := avaPattern *[ "+" avaPattern ] * avaPattern := name "=" value | * name "=" "$attr" "." attrName [ "." attrNumber ] | * name "=" "$dn" "." attrName [ "." attrNumber ] | * "$dn" "." "$rdn" "." number ** *
* Example1: E=$attr.mail.1, CN=$attr.cn, OU=$dn.ou.2, O=$dn.o, C=US * Ldap entry: dn: UID=jjames, OU=IS, OU=people, O=acme.org * Ldap attributes: cn: Jesse James * Ldap attributes: mail: jjames@acme.org ** ** The subject name formulated will be :
* E=jjames@acme.org, CN=Jesse James, OU=people, O=acme.org, C=US ** E = the first 'mail' ldap attribute value in user's entry.
* CN = the (first) 'cn' ldap attribute value in the user's entry.
* OU = the second 'ou' value in the user's entry DN.
* O = the (first) 'o' value in the user's entry DN.
* C = the string "US" ** Example2: E=$attr.mail.1, CN=$attr.cn, OU=$dn.ou.2, O=$dn.o, C=US * Ldap entry: dn: UID=jjames, OU=IS+OU=people, O=acme.org * Ldap attributes: cn: Jesse James * Ldap attributes: mail: jjames@acme.org *
* The subject name formulated will be :
* E=jjames@acme.org, CN=Jesse James, OU=people, O=acme.org, C=US ** E = the first 'mail' ldap attribute value in user's entry.
* CN = the (first) 'cn' ldap attribute value in the user's entry.
* OU = the second 'ou' value in the user's entry DN. note multiple AVAs * in a RDN in this example.
* O = the (first) 'o' value in the user's entry DN.
* C = the string "US" **
* Example3: CN=$attr.cn, $rdn.2, O=$dn.o, C=US * Ldap entry: dn: UID=jjames, OU=IS+OU=people, O=acme.org * Ldap attributes: cn: Jesse James * Ldap attributes: mail: jjames@acme.org ** * If an attribute or subject DN component does not exist the attribute is skipped. * * @version $Revision$, $Date$ */ public class DNPattern { /* ldap attributes to retrieve */ private String[] mLdapAttrs = null; /* rdn patterns */ protected RDNPattern[] 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 DNPattern(String pattern) throws EAuthException { if (pattern == null || pattern.equals("")) { // create an attribute list that is the dn. mLdapAttrs = new String[] { "dn" }; } else { mPatternString = pattern; PushbackReader in = new PushbackReader(new StringReader(pattern)); parse(in); } } public DNPattern(PushbackReader in) throws EAuthException { parse(in); } private void parse(PushbackReader in) throws EAuthException { Vector* The subject name formulated will be :
* CN=Jesse James, OU=IS+OU=people, O=acme.org, C=US ** CN = the (first) 'cn' ldap attribute value in the user's entry.
* followed by the second RDN in the user's entry DN.
* O = the (first) 'o' value in the user's entry DN.
* C = the string "US" ** Example4: CN=$attr.cn, OU=$dn.ou.2+OU=$dn.ou.1, O=$dn.o, C=US * Ldap entry: dn: UID=jjames, OU=IS+OU=people, O=acme.org * Ldap attributes: cn: Jesse James * Ldap attributes: mail: jjames@acme.org *
* The subject name formulated will be :
* CN=Jesse James, OU=people+OU=IS, O=acme.org, C=US ** CN = the (first) 'cn' ldap attribute value in the user's entry.
* OU = the second 'ou' value in the user's entry DN followed by the * first 'ou' value in the user's entry. note multiple AVAs * in a RDN in this example.
* O = the (first) 'o' value in the user's entry DN.
* C = the string "US" **