summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/cmscore/ldapconn/LdapBoundConnection.java
blob: fc97ab48c9ff0452568ad72b719ee2e82058ac84 (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
// --- 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.ldapconn;

import java.util.Properties;

import netscape.ldap.LDAPConnection;
import netscape.ldap.LDAPException;
import netscape.ldap.LDAPRebind;
import netscape.ldap.LDAPRebindAuth;
import netscape.ldap.LDAPSocketFactory;
import netscape.ldap.LDAPv2;

import com.netscape.certsrv.apps.CMS;

/**
 * A LDAP connection that is bound to a server host, port, secure type.
 * and authentication.
 * Makes a LDAP connection and authentication when instantiated.
 * Cannot establish another LDAP connection or authentication after
 * construction. LDAPConnection connect and authentication methods are
 * overridden to prevent this.
 */
public class LdapBoundConnection extends LDAPConnection {
    /**
     *
     */
    private static final long serialVersionUID = -2242077674357271559L;
    // LDAPConnection calls authenticate so must set this for first 
    // authenticate call.
    private boolean mAuthenticated = false;

    /**
     * Instantiates a connection to a ldap server, secure or non-secure
     * connection with Ldap basic bind dn & pw authentication.
     */
    public LdapBoundConnection(
            LdapConnInfo connInfo, LdapAuthInfo authInfo)
            throws LDAPException {
        // this LONG line to satisfy super being the first call. (yuk)
        super(
                authInfo.getAuthType() == LdapAuthInfo.LDAP_AUTHTYPE_SSLCLIENTAUTH ?
                        new LdapJssSSLSocketFactory(authInfo.getParms()[0]) :
                        (connInfo.getSecure() ? new LdapJssSSLSocketFactory() : null));

        // Set option to automatically follow referrals. 
        // Use the same credentials to follow referrals; this is the easiest 
        // thing to do without any complicated configuration using 
        // different hosts.
        // If client auth is used don't have dn and pw to follow referrals.

        boolean followReferrals = connInfo.getFollowReferrals();

        setOption(LDAPv2.REFERRALS, new Boolean(followReferrals));
        if (followReferrals &&
                authInfo.getAuthType() != LdapAuthInfo.LDAP_AUTHTYPE_SSLCLIENTAUTH) {
            LDAPRebind rebindInfo =
                    new ARebindInfo(authInfo.getParms()[0],
                            authInfo.getParms()[1]);

            setOption(LDAPv2.REFERRALS_REBIND_PROC, rebindInfo);
        }

        if (authInfo.getAuthType() == LdapAuthInfo.LDAP_AUTHTYPE_SSLCLIENTAUTH) {
            // will be bound to client auth cert mapped entry.
            super.connect(connInfo.getHost(), connInfo.getPort());
            CMS.debug(
                    "Established LDAP connection with SSL client auth to " +
                            connInfo.getHost() + ":" + connInfo.getPort());
        } else { // basic auth
            String binddn = authInfo.getParms()[0];
            String bindpw = authInfo.getParms()[1];

            super.connect(connInfo.getVersion(),
                    connInfo.getHost(), connInfo.getPort(), binddn, bindpw);
            CMS.debug(
                    "Established LDAP connection using basic authentication to" +
                            " host " + connInfo.getHost() +
                            " port " + connInfo.getPort() +
                            " as " + binddn);
        }
    }

    /**
     * Instantiates a connection to a ldap server, secure or non-secure
     * connection with Ldap basic bind dn & pw authentication.
     */
    public LdapBoundConnection(String host, int port, int version,
            LDAPSocketFactory fac,
            String bindDN, String bindPW)
            throws LDAPException {
        super(fac);
        if (bindDN != null) {
            super.connect(version, host, port, bindDN, bindPW);
            CMS.debug(
                    "Established LDAP connection using basic authentication " +
                            " as " + bindDN + " to " + host + ":" + port);
        } else {
            if (fac == null && bindDN == null) {
                throw new IllegalArgumentException(
                        "Ldap bound connection must have authentication info.");
            }
            // automatically authenticated if it's ssl client auth.
            super.connect(version, host, port, null, null);
            CMS.debug(
                    "Established LDAP connection using SSL client authentication " +
                            "to " + host + ":" + port);
        }
    }

    /**
     * Overrides same method in LDAPConnection to do prevent re-authentication.
     */
    public void authenticate(int version, String dn, String pw)
            throws LDAPException {

        /**
         * if (mAuthenticated) {
         * throw new RuntimeException(
         * "this LdapBoundConnection already authenticated: auth(v,dn,pw)");
         * }
         **/
        super.authenticate(version, dn, pw);
        mAuthenticated = true;
    }

    /**
     * Overrides same method in LDAPConnection to do prevent re-authentication.
     */
    public void authenticate(String dn, String pw)
            throws LDAPException {

        /**
         * if (mAuthenticated) {
         * throw new RuntimeException(
         * "this LdapBoundConnection already authenticated: auth(dn,pw)");
         * }
         **/
        super.authenticate(3, dn, pw);
        mAuthenticated = true;
    }

    /**
     * Overrides same method in LDAPConnection to do prevent re-authentication.
     */
    public void authenticate(String dn, String mech, String packageName,
            Properties props, Object getter)
            throws LDAPException {

        /**
         * if (mAuthenticated) {
         * throw new RuntimeException(
         * "this LdapBoundConnection already authenticated: auth(mech)");
         * }
         **/
        super.authenticate(dn, mech, packageName, props, getter);
        mAuthenticated = true;
    }

    /**
     * Overrides same method in LDAPConnection to do prevent re-authentication.
     */
    public void authenticate(String dn, String mechs[], String packageName,
            Properties props, Object getter)
            throws LDAPException {

        /**
         * if (mAuthenticated) {
         * throw new RuntimeException(
         * "this LdapBoundConnection is already authenticated: auth(mechs)");
         * }
         **/
        super.authenticate(dn, mechs, packageName, props, getter);
        mAuthenticated = true;
    }

    /**
     * overrides parent's connect to prevent re-connect.
     */
    public void connect(String host, int port) throws LDAPException {
        throw new RuntimeException(
                "this LdapBoundConnection is already connected: conn(host,port)");
    }

    /**
     * overrides parent's connect to prevent re-connect.
     */
    public void connect(int version, String host, int port,
            String dn, String pw) throws LDAPException {
        throw new RuntimeException(
                "this LdapBoundConnection is already connected: conn(version,h,p)");
    }
}

class ARebindInfo implements LDAPRebind {
    private LDAPRebindAuth mRebindAuthInfo = null;

    public ARebindInfo(String binddn, String pw) {
        mRebindAuthInfo = new LDAPRebindAuth(binddn, pw);
    }

    public LDAPRebindAuth getRebindAuthentication(String host, int port) {
        return mRebindAuthInfo;
    }
}