Updated copyright headers. Omit CVS ID.
[metaproxy-moved-to-github.git] / src / filter_auth_simple.cpp
1 /* This file is part of Metaproxy.
2    Copyright (C) 2005-2008 Index Data
3
4 Metaproxy is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
7 version.
8
9 Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12 for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17 */
18
19 #include "config.hpp"
20
21 #include "filter.hpp"
22 #include "package.hpp"
23
24 #include <boost/thread/mutex.hpp>
25 #include <boost/algorithm/string.hpp>
26
27 #include "util.hpp"
28 #include "filter_auth_simple.hpp"
29
30 #include <yaz/zgdu.h>
31 #include <yaz/diagbib1.h>
32 #include <stdio.h>
33 #include <errno.h>
34
35 namespace mp = metaproxy_1;
36 namespace yf = mp::filter;
37
38 namespace metaproxy_1 {
39     namespace filter {
40         class AuthSimple::Rep {
41             friend class AuthSimple;
42             struct PasswordAndDBs {
43                 std::string password;
44                 std::list<std::string> dbs;
45                 PasswordAndDBs() {};
46                 PasswordAndDBs(std::string pw) : password(pw) {};
47                 void addDB(std::string db) { dbs.push_back(db); }
48             };
49             boost::mutex mutex;
50             bool got_userRegister, got_targetRegister;
51             std::map<std::string, PasswordAndDBs> userRegister;
52             std::map<std::string, std::list<std::string> > targetsByUser;
53             std::map<mp::Session, std::string> userBySession;
54             bool discardUnauthorisedTargets;
55             Rep() { got_userRegister = false;
56                     got_targetRegister = false;
57                     discardUnauthorisedTargets = false; }
58         };
59     }
60 }
61
62 yf::AuthSimple::AuthSimple() : m_p(new Rep)
63 {
64     // nothing to do
65 }
66
67 yf::AuthSimple::~AuthSimple()
68 {  // must have a destructor because of boost::scoped_ptr
69 }
70
71
72 static void die(std::string s) { throw mp::filter::FilterException(s); }
73
74
75 // Read XML config.. Put config info in m_p.
76 void mp::filter::AuthSimple::configure(const xmlNode * ptr, bool test_only)
77 {
78     std::string userRegisterName;
79     std::string targetRegisterName;
80
81     for (ptr = ptr->children; ptr != 0; ptr = ptr->next) {
82         if (ptr->type != XML_ELEMENT_NODE)
83             continue;
84         if (!strcmp((const char *) ptr->name, "userRegister")) {
85             userRegisterName = mp::xml::get_text(ptr);
86             m_p->got_userRegister = true;
87         } else if (!strcmp((const char *) ptr->name, "targetRegister")) {
88             targetRegisterName = mp::xml::get_text(ptr);
89             m_p->got_targetRegister = true;
90         } else if (!strcmp((const char *) ptr->name,
91                            "discardUnauthorisedTargets")) {
92             m_p->discardUnauthorisedTargets = true;
93         } else {
94             die("Bad element in auth_simple: <"
95                 + std::string((const char *) ptr->name) + ">");
96         }
97     }
98
99     if (!m_p->got_userRegister && !m_p->got_targetRegister)
100         die("auth_simple: no user-register or target-register "
101             "filename specified");
102
103     if (m_p->got_userRegister)
104         config_userRegister(userRegisterName);
105     if (m_p->got_targetRegister)
106         config_targetRegister(targetRegisterName);
107 }
108
109
110 void mp::filter::AuthSimple::config_userRegister(std::string filename)
111 {
112     FILE *fp = fopen(filename.c_str(), "r");
113     if (fp == 0)
114         die("can't open auth_simple user-register '" + filename + "': " +
115             strerror(errno));
116
117     char buf[1000];
118     while (fgets(buf, sizeof buf, fp)) {
119         if (*buf == '\n' || *buf == '#')
120             continue;
121         buf[strlen(buf)-1] = 0;
122         char *passwdp = strchr(buf, ':');
123         if (passwdp == 0)
124             die("auth_simple user-register '" + filename + "': " +
125                 "no password on line: '" + buf + "'");
126         *passwdp++ = 0;
127         char *databasesp = strchr(passwdp, ':');
128         if (databasesp == 0)
129             die("auth_simple user-register '" + filename + "': " +
130                 "no databases on line: '" + buf + ":" + passwdp + "'");
131         *databasesp++ = 0;
132         yf::AuthSimple::Rep::PasswordAndDBs tmp(passwdp);
133         boost::split(tmp.dbs, databasesp, boost::is_any_of(","));
134         m_p->userRegister[buf] = tmp;
135
136         if (0) {                // debugging
137             printf("Added user '%s' -> password '%s'\n", buf, passwdp);
138             std::list<std::string>::const_iterator i;
139             for (i = tmp.dbs.begin(); i != tmp.dbs.end(); i++) {
140                 printf("db '%s'\n", (*i).c_str());
141             }
142         }
143     }
144 }
145
146
147 // I feel a little bad about the duplication of code between this and
148 // config_userRegister().  But not bad enough to refactor.
149 //
150 void mp::filter::AuthSimple::config_targetRegister(std::string filename)
151 {
152     FILE *fp = fopen(filename.c_str(), "r");
153     if (fp == 0)
154         die("can't open auth_simple target-register '" + filename + "': " +
155             strerror(errno));
156
157     char buf[1000];
158     while (fgets(buf, sizeof buf, fp)) {
159         if (*buf == '\n' || *buf == '#')
160             continue;
161         buf[strlen(buf)-1] = 0;
162         char *targetsp = strchr(buf, ':');
163         if (targetsp == 0)
164             die("auth_simple target-register '" + filename + "': " +
165                 "no targets on line: '" + buf + "'");
166         *targetsp++ = 0;
167         std::list<std::string> tmp;
168         boost::split(tmp, targetsp, boost::is_any_of(","));
169         m_p->targetsByUser[buf] = tmp;
170
171         if (0) {                // debugging
172             printf("Added user '%s' with targets:\n", buf);
173             std::list<std::string>::const_iterator i;
174             for (i = tmp.begin(); i != tmp.end(); i++) {
175                 printf("\t%s\n", (*i).c_str());
176             }
177         }
178     }
179 }
180
181
182 void yf::AuthSimple::process(mp::Package &package) const
183 {
184     Z_GDU *gdu = package.request().get();
185
186     if (!gdu || gdu->which != Z_GDU_Z3950) {
187         // Pass on the package -- This means that authentication is
188         // waived, which may not be the correct thing for non-Z APDUs
189         // as it means that SRW sessions don't demand authentication
190         return package.move();
191     }
192
193     if (m_p->got_userRegister) {
194         switch (gdu->u.z3950->which) {
195         case Z_APDU_initRequest: return process_init(package);
196         case Z_APDU_searchRequest: return process_search(package);
197         case Z_APDU_scanRequest: return process_scan(package);
198             // In theory, we should check database authorisation for
199             // extended services, too (A) the proxy currently does not
200             // implement XS and turns off its negotiation bit; (B) it
201             // would be insanely complex to do as the top-level XS request
202             // structure does not carry a database name, but it is buried
203             // down in some of the possible EXTERNALs used as
204             // taskSpecificParameters; and (C) since many extended
205             // services modify the database, we'd need to more exotic
206             // authorisation database than we want to support.
207         default: break;
208         }
209     }
210
211     if (m_p->got_targetRegister && gdu->u.z3950->which == Z_APDU_initRequest)
212         return check_targets(package);
213
214     // Operations other than those listed above do not require authorisation
215     return package.move();
216 }
217
218
219 static void reject_init(mp::Package &package, int err, const char *addinfo);
220
221
222 void yf::AuthSimple::process_init(mp::Package &package) const
223 {
224     Z_IdAuthentication *auth =
225         package.request().get()->u.z3950->u.initRequest->idAuthentication;
226         // This is just plain perverted.
227
228     if (!auth)
229         return reject_init(package, 0, "no credentials supplied");
230     if (auth->which != Z_IdAuthentication_idPass)
231         return reject_init(package, 0,
232                            "only idPass authentication is supported");
233     Z_IdPass *idPass = auth->u.idPass;
234
235     if (m_p->userRegister.count(idPass->userId)) {
236         // groupId is ignored, in accordance with ancient tradition.
237         yf::AuthSimple::Rep::PasswordAndDBs pdbs =
238             m_p->userRegister[idPass->userId];
239         if (pdbs.password == idPass->password) {
240             // Success!  Remember who the user is for future reference
241             {
242                 boost::mutex::scoped_lock lock(m_p->mutex);
243                 m_p->userBySession[package.session()] = idPass->userId;
244             }
245             return package.move();
246         }
247     }
248
249     return reject_init(package, 0, "username/password combination rejected");
250 }
251
252
253 // I find it unutterable disappointing that I have to provide this
254 static bool contains(std::list<std::string> list, std::string thing) {
255     std::list<std::string>::const_iterator i;
256     for (i = list.begin(); i != list.end(); i++)
257         if (mp::util::database_name_normalize(*i) == 
258             mp::util::database_name_normalize(thing))
259             return true;
260     
261     return false;
262 }
263
264
265 void yf::AuthSimple::process_search(mp::Package &package) const
266 {
267     Z_SearchRequest *req =
268         package.request().get()->u.z3950->u.searchRequest;
269
270     if (m_p->userBySession.count(package.session()) == 0) {
271         // It's a non-authenticated session, so just accept the operation
272         return package.move();
273     }
274
275     std::string user = m_p->userBySession[package.session()];
276     yf::AuthSimple::Rep::PasswordAndDBs pdb = m_p->userRegister[user];
277     for (int i = 0; i < req->num_databaseNames; i++) {
278         if (!contains(pdb.dbs, req->databaseNames[i]) &&
279             !contains(pdb.dbs, "*")) {
280             // Make an Search rejection APDU
281             mp::odr odr;
282             Z_APDU *apdu = odr.create_searchResponse(
283                 package.request().get()->u.z3950, 
284                 YAZ_BIB1_ACCESS_TO_SPECIFIED_DATABASE_DENIED,
285                 req->databaseNames[i]);
286             package.response() = apdu;
287             package.session().close();
288             return;
289         }
290     }
291
292     // All the requested databases are acceptable
293     return package.move();
294 }
295
296
297 void yf::AuthSimple::process_scan(mp::Package &package) const
298 {
299     Z_ScanRequest *req =
300         package.request().get()->u.z3950->u.scanRequest;
301
302     if (m_p->userBySession.count(package.session()) == 0) {
303         // It's a non-authenticated session, so just accept the operation
304         return package.move();
305     }
306
307     std::string user = m_p->userBySession[package.session()];
308     yf::AuthSimple::Rep::PasswordAndDBs pdb = m_p->userRegister[user];
309     for (int i = 0; i < req->num_databaseNames; i++) {
310         if (!contains(pdb.dbs, req->databaseNames[i]) &&
311             !contains(pdb.dbs, "*")) {
312             // Make an Scan rejection APDU
313             mp::odr odr;
314             Z_APDU *apdu = odr.create_scanResponse(
315                 package.request().get()->u.z3950, 
316                 YAZ_BIB1_ACCESS_TO_SPECIFIED_DATABASE_DENIED,
317                 req->databaseNames[i]);
318             package.response() = apdu;
319             package.session().close();
320             return;
321         }
322     }
323
324     // All the requested databases are acceptable
325     return package.move();
326 }
327
328
329 static void reject_init(mp::Package &package, int err, const char *addinfo) { 
330     if (err == 0)
331         err = YAZ_BIB1_INIT_AC_AUTHENTICATION_SYSTEM_ERROR;
332     // Make an Init rejection APDU
333     Z_GDU *gdu = package.request().get();
334     mp::odr odr;
335     Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, err, addinfo);
336     apdu->u.initResponse->implementationName = "YP2/YAZ";
337     *apdu->u.initResponse->result = 0; // reject
338     package.response() = apdu;
339     package.session().close();
340 }
341
342
343 void yf::AuthSimple::check_targets(mp::Package & package) const
344 {
345     Z_InitRequest *initReq = package.request().get()->u.z3950->u.initRequest;
346
347     Z_IdAuthentication *auth = initReq->idAuthentication;
348     // We only get into this method if we are dealing with a session
349     // that has been authenticated using idPass authentication.  So we
350     // know what kind of information is in the Init Request, and we
351     // can trust the username without needing to re-authenticate.
352     assert(auth->which == Z_IdAuthentication_idPass);
353     std::string user = auth->u.idPass->userId;
354     std::list<std::string> authorisedTargets = m_p->targetsByUser[user];
355
356     std::list<std::string> targets;
357     Z_OtherInformation **otherInfo = &initReq->otherInfo;
358     mp::util::remove_vhost_otherinfo(otherInfo, targets);
359
360     // Check each of the targets specified in the otherInfo package
361     std::list<std::string>::iterator i;
362
363     i = targets.begin();
364     while (i != targets.end()) {
365         if (contains(authorisedTargets, *i) ||
366             contains(authorisedTargets, "*")) {
367             i++;
368         } else {
369             if (!m_p->discardUnauthorisedTargets)
370                 return reject_init(package,
371                     YAZ_BIB1_ACCESS_TO_SPECIFIED_DATABASE_DENIED, i->c_str());
372             i = targets.erase(i);
373         }
374     }
375
376     if (targets.size() == 0)
377         return reject_init(package,
378                            YAZ_BIB1_ACCESS_TO_SPECIFIED_DATABASE_DENIED,
379                            // ### It would be better to use the Z-db name
380                            "all databases");
381     mp::odr odr;
382     mp::util::set_vhost_otherinfo(otherInfo, odr, targets);
383     package.move();
384 }
385
386
387 static mp::filter::Base* filter_creator()
388 {
389     return new mp::filter::AuthSimple;
390 }
391
392 extern "C" {
393     struct metaproxy_1_filter_struct metaproxy_1_filter_auth_simple = {
394         0,
395         "auth_simple",
396         filter_creator
397     };
398 }
399
400
401 /*
402  * Local variables:
403  * c-basic-offset: 4
404  * indent-tabs-mode: nil
405  * c-file-style: "stroustrup"
406  * End:
407  * vim: shiftwidth=4 tabstop=8 expandtab
408  */