/*
 * lib/kdb/kdb_db2.h
 *
 * Copyright 1997 by the Massachusetts Institute of Technology.
 * All Rights Reserved.
 *
 * Export of this software from the United States of America may
 *   require a specific license from the United States Government.
 *   It is the responsibility of any person or organization contemplating
 *   export to obtain such a license before exporting.
 *
 * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
 * distribute this software and its documentation for any purpose and
 * without fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright notice and
 * this permission notice appear in supporting documentation, and that
 * the name of M.I.T. not be used in advertising or publicity pertaining
 * to distribution of the software without specific, written prior
 * permission.  Furthermore if you modify this software you must label
 * your software as modified software and not distribute it in such a
 * fashion that it might be confused with the original M.I.T. software.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is" without express
 * or implied warranty.
 *
 *
 * KDC Database backend definitions for Berkely DB.
 */
#ifndef KRB5_KDB_DB2_H
#define KRB5_KDB_DB2_H

#include "policy_db.h"

typedef struct _krb5_db2_context {
    krb5_boolean        db_inited;      /* Context initialized          */
    char *              db_name;        /* Name of database             */
    DB *                db;             /* DB handle                    */
    krb5_boolean        hashfirst;      /* Try hash database type first */
    char *              db_lf_name;     /* Name of lock file            */
    int                 db_lf_file;     /* File descriptor of lock file */
    time_t              db_lf_time;     /* Time last updated            */
    int                 db_locks_held;  /* Number of times locked       */
    int                 db_lock_mode;   /* Last lock mode, e.g. greatest*/
    krb5_boolean        db_nb_locks;    /* [Non]Blocking lock modes     */
    krb5_keyblock      *db_master_key;  /* Master key of database       */
    osa_adb_policy_t    policy_db;
    krb5_boolean tempdb;
} krb5_db2_context;

#define KRB5_DB2_MAX_RETRY 5

#define KDB2_LOCK_EXT ".ok"
#define KDB2_TEMP_LOCK_EXT "~.ok"

krb5_error_code krb5_db2_db_init
        (krb5_context);
krb5_error_code krb5_db2_db_fini
        (krb5_context);
krb5_error_code krb5_db2_db_get_age
        (krb5_context,
                   char *,
                   time_t * );
krb5_error_code krb5_db2_db_create
        (krb5_context,
                   char *,
                   krb5_int32);
krb5_error_code krb5_db2_db_destroy
        (krb5_context,
                   char * );
krb5_error_code krb5_db2_db_rename
        (krb5_context,
                   char *,
                   char * );
krb5_error_code krb5_db2_db_get_principal
        (krb5_context,
                   krb5_const_principal,
                   krb5_db_entry *,
                   int *,
                   krb5_boolean * );
krb5_error_code krb5_db2_db_free_principal
        (krb5_context,
                   krb5_db_entry *,
                   int );
krb5_error_code krb5_db2_db_put_principal
        (krb5_context,
         krb5_db_entry *,
         int *,
         char **db_args
         );
krb5_error_code krb5_db2_db_iterate_ext
        (krb5_context,
                   krb5_error_code (*) (krb5_pointer,
                                                  krb5_db_entry *),
                   krb5_pointer, int, int );
/* Solaris Kerberos: adding support for db_args */
krb5_error_code krb5_db2_db_iterate
(krb5_context,char *,
                   krb5_error_code (*) (krb5_pointer,
                                                  krb5_db_entry *),
                   krb5_pointer,
                   char **db_args );
krb5_error_code krb5_db2_db_set_nonblocking
        (krb5_context,
                   krb5_boolean,
                   krb5_boolean * );
krb5_boolean krb5_db2_db_set_lockmode
        (krb5_context,
                   krb5_boolean );
krb5_error_code krb5_db2_db_open_database
        (krb5_context);
krb5_error_code krb5_db2_db_close_database
        (krb5_context);

krb5_error_code
krb5_db2_set_master_key_ext ( krb5_context kcontext,
                              char *pwd,
                              krb5_keyblock *key);

krb5_error_code
krb5_db2_db_set_mkey( krb5_context context,
                      krb5_keyblock *key);

krb5_error_code
krb5_db2_db_get_mkey( krb5_context context,
                      krb5_keyblock **key);

krb5_error_code
krb5_db2_db_put_principal( krb5_context context,
                           krb5_db_entry *entries,
                           register int *nentries,
                           char **db_args);

krb5_error_code
krb5_db2_db_delete_principal(krb5_context context,
                             krb5_const_principal searchfor,
                             int *nentries);

krb5_error_code krb5_db2_lib_init(void);

krb5_error_code krb5_db2_lib_cleanup(void);

krb5_error_code
krb5_db2_db_unlock(krb5_context);

krb5_error_code
krb5_db2_promote_db(krb5_context kcontext,
                    char *conf_section,
                    char **db_args);

krb5_error_code
krb5_db2_db_set_option ( krb5_context kcontext,
                         int option,
                         void *value );

krb5_error_code
krb5_db2_db_lock( krb5_context    context,
                  int             in_mode);


krb5_error_code
krb5_db2_open( krb5_context kcontext,
                               char *conf_section,
                               char **db_args,
                               int mode );

krb5_error_code krb5_db2_create( krb5_context kcontext,
                                 char *conf_section,
                                 char **db_args );

krb5_error_code krb5_db2_destroy( krb5_context kcontext,
                                  char *conf_section,
                                  char **db_args );

const char * krb5_db2_err2str( krb5_context kcontext,
                               long err_code );

void *
krb5_db2_alloc( krb5_context kcontext,
                void *ptr,
                size_t size );

void
krb5_db2_free( krb5_context kcontext,
                    void *ptr );

const char *
krb5_db2_errcode_2_string(krb5_context kcontext,
                    long err_code);

void
krb5_db2_release_errcode_string(krb5_context kcontext,
                    const char *msg);



/* policy management functions */
krb5_error_code
krb5_db2_create_policy(krb5_context context, osa_policy_ent_t entry);

krb5_error_code krb5_db2_get_policy ( krb5_context kcontext,
                                      char *name,
                                      osa_policy_ent_t *policy,
                                      int *cnt);

krb5_error_code krb5_db2_put_policy ( krb5_context kcontext,
                                      osa_policy_ent_t policy );

krb5_error_code krb5_db2_iter_policy ( krb5_context kcontext,
                                       char *match_entry,
                                       osa_adb_iter_policy_func func,
                                       void *data );

krb5_error_code krb5_db2_delete_policy ( krb5_context kcontext,
                                         char *policy );

void krb5_db2_free_policy( krb5_context kcontext,
                           osa_policy_ent_t entry );

#endif /* KRB5_KDB_DB2_H */