1 /* $Id: module.h,v 1.6 2005-06-25 15:58:33 adam Exp $
2 Copyright (c) 1998-2005, Index Data.
4 This file is part of the yaz-proxy.
6 YAZ proxy is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 2, or (at your option) any later
11 YAZ proxy is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 You should have received a copy of the GNU General Public License
17 along with YAZ proxy; see the file LICENSE. If not, write to the
18 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
22 #ifndef YAZ_PROXY_MODULE_H
23 #define YAZ_PROXY_MODULE_H_INCLUDED
25 struct Yaz_ProxyModule_entry {
28 char *module_description;
32 #define YAZPROXY_RET_NOT_ME 0 /* Did not catch it. pass to other handler */
33 #define YAZPROXY_RET_OK 1 /* OK, grabbed */
34 #define YAZPROXY_RET_PERM 2 /* Permissiong denied, reject etc. */
36 struct Yaz_ProxyModule_int0 {
37 void *(*init)(void); // Init handler - returns module-specific handle
39 void (*destroy)( // Destroy handler
40 void *handle // module-specific handle as returned by init
43 int (*authenticate)( // Authenticate handler. Returns YAZPROXY_RET_..
44 void *handle, // module-specific handle as returned by init
45 const char *name, // target name (or NULL if default target)
46 void *element_ptr, // xmlnodePtr thing to XML config this
47 const char *user, // User ID (or NULL if no suppliied User ID)
48 const char *group, // Group ID (or NULL if no supplied Group ID)
49 const char *pw, // Password (or NULL if no supplied password)
50 const char *peer_IP// IP address of client
54 class Yaz_ProxyModule;
56 class Yaz_ProxyModules {
57 friend class Proxy_Msg;
61 int authenticate(const char *module_name,
62 const char *target_name, void *element_ptr,
67 int add_module(const char *fname);
68 void unload_modules();
70 Yaz_ProxyModule *m_list;
78 * indent-tabs-mode: nil
80 * vim: shiftwidth=4 tabstop=8 expandtab