/* eurephiadb_driver.h  --  API provided by the database driver
 *
 *  GPLv2 only - Copyright (C) 2008, 2009
 *               David Sommerseth <dazo@users.sourceforge.net>
 *
 *  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.
*/

#include <eurephia_context.h>
#include <eurephiadb_session_struct.h>
#include <eurephia_values_struct.h>
#include <eurephia_admin_struct.h>

#ifdef HAVE_LIBXML2
#include <libxml/tree.h>
#endif

#ifndef EUREPHIADB_DRIVER_H_
#define EUREPHIADB_DRIVER_H_

#define attempt_IPADDR      1
#define attempt_CERTIFICATE 2
#define attempt_USERNAME    3

#define ATTEMPT_RESET    0x0A
#define ATTEMPT_REGISTER 0x0B

#define USERINFO_user       0x01
#define USERINFO_certs      0x02
#define USERINFO_lastlog    0x04
#define USERINFO_attempts   0x08
#define USERINFO_blacklist  0x10

#ifndef DRIVER_MODE

/* Functions needed by all drivers */
const char *(*eDB_DriverVersion) (void);
int (*eDB_DriverAPIVersion) (void);


/*
 *    functions which needs to exists in the eurephiaDB (eDB) module - API Version 1
 */
int (*eDBconnect) (eurephiaCTX *ctx, const int argc, const char **argv);

void (*eDBdisconnect) (eurephiaCTX *ctx);

int (*eDBauth_TLS) (eurephiaCTX *ctx, const char *org, const char *cname, const char *email,
                    const char *digest, const char *depth);

int (*eDBauth_user) (eurephiaCTX *ctx, const int certid, const char *username, const char *passwd);

int (*eDBget_uid) (eurephiaCTX *ctx, const int certid, const char *username);

int (*eDBblacklist_check) (eurephiaCTX *ctx, const int type, const char *val);

void (*eDBregister_attempt) (eurephiaCTX *ctx, int type, int mode, const char *value);


int (*eDBregister_login) (eurephiaCTX *ctx, eurephiaSESSION *skey, const int certid, const int uid,
                          const char *proto, const char *remipaddr, const char *remport,
                          const char *vpnipaddr, const char *vpnipmask);

int (*eDBregister_vpnmacaddr) (eurephiaCTX *ctx, eurephiaSESSION *skey, const char *macaddr);

int (*eDBregister_logout) (eurephiaCTX *ctx, eurephiaSESSION *skey,
                           const char *bytes_sent, const char *bytes_received, const char *duration);

/* firewall functions */
char *(*eDBget_firewall_profile) (eurephiaCTX *ctx, eurephiaSESSION *session);
eurephiaVALUES *(*eDBget_blacklisted_ip) (eurephiaCTX *ctx);

/* The following functions is also declared in eurephia_session_values.c - for local internal usage. */
char *(*eDBget_sessionkey_seed) (eurephiaCTX *ctx, sessionType type, const char *sessionseed);
char *(*eDBget_sessionkey_macaddr) (eurephiaCTX *ctx, const char *macaddr);
int (*eDBcheck_sessionkey_uniqueness) (eurephiaCTX *ctx, const char *seskey);

int (*eDBregister_sessionkey) (eurephiaCTX *ctx, const char *seed, const char *seskey);

eurephiaVALUES *(*eDBload_sessiondata) (eurephiaCTX *ctx, const char *sesskey);

int (*eDBdestroy_session) (eurephiaCTX *ctx, eurephiaSESSION *session);

int (*eDBstore_session_value) (eurephiaCTX *ctx, eurephiaSESSION *skey, int mode,
                               const char *key, const char *val);

/* API version 2 functions */
int (*eDBadminAuth) (eurephiaCTX *ctx, const char *req_acc, const char *uname, const char *pwd);
int (*eDBadminValidateSession) (eurephiaCTX *ctx, const char *sesskey, const char *req_acc);
int (*eDBadminRegisterLogin) (eurephiaCTX *ctx, eurephiaSESSION *session);
int (*eDBadminLogout) (eurephiaCTX *ctx, const char *session);

int (*eDBadminConfigSet) (eurephiaCTX *ctx, const char *key, const char *val);
int (*eDBadminConfigDelete) (eurephiaCTX *ctx, const char *key);

#ifdef HAVE_LIBXML2
xmlDoc *(*eDBadminGetUserList) (eurephiaCTX *ctx, const char *sortkeys);
xmlDoc *(*eDBadminGetUserInfo) (eurephiaCTX *ctx, int infoType, xmlDoc *srch);
int (*eDBadminAddUser) (eurephiaCTX *ctx, xmlDoc *userinfo);
int (*eDBadminUpdateUser) (eurephiaCTX *ctx, const int uid, xmlDoc *userinfo);
int (*eDBadminDeleteUser) (eurephiaCTX *ctx, const int uid, xmlDoc *userinfo);

xmlDoc *(*eDBadminGetCertificateList) (eurephiaCTX *ctx, const char *sortkeys);
xmlDoc *(*eDBadminGetCertificateInfo) (eurephiaCTX *ctx, xmlDoc *searchkey, const char *sortkeys);
int (*eDBadminAddCertificate) (eurephiaCTX *ctx, xmlDoc *certinfo);
int (*eDBadminDeleteCertificate) (eurephiaCTX *ctx, xmlDoc *certinfo);

xmlDoc *(*eDBadminGetUserCertsList) (eurephiaCTX *ctx, const char *sortkeys);
int (*eDBadminUpdateUserCertLink) (eurephiaCTX *ctx, xmlDoc *usrcrt_xml);

xmlDoc *(*eDBadminGetAdminAccess) (eurephiaCTX *ctx, xmlDoc *srch_xml);
int (*eDBadminEditAdminAccess) (eurephiaCTX *ctx, xmlDoc *grant_xml);

xmlDoc *(*eDBadminGetFirewallProfiles) (eurephiaCTX *ctx, xmlDoc *srch);

xmlDoc *(*eDBadminGetLastlog) (eurephiaCTX *ctx, xmlDoc *srch, const char *sortkeys);
xmlDoc *(*eDBadminGetAttemptsLog) (eurephiaCTX *ctx, xmlDoc *usersrch, xmlDoc *certsrch, const char *sortkeys);
#endif /* HAVE_LIBXML2 */

#endif /* !DRIVER_MODE */

#endif /* !EUREPHIADB_DRIVER_H_ */