lib/kadm5/private.h

   1 /*
   2  * Copyright (c) 1997-2000 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the Institute nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 /* $Id$ */
  35
  36 #ifndef __kadm5_privatex_h__
  37 #define __kadm5_privatex_h__
  38
  39 #include "kadm5-hook.h"
  40
  41 #ifdef HAVE_SYS_UN_H
  42 #include <sys/un.h>
  43 #endif
  44
  45 struct kadm_func {
  46     kadm5_ret_t (*chpass_principal) (void *, krb5_principal, int,
  47                                      int, krb5_key_salt_tuple*, const char*);
  48     kadm5_ret_t (*create_principal) (void*, kadm5_principal_ent_t, uint32_t,
  49                                      int, krb5_key_salt_tuple *,
  50                                      const char*);
  51     kadm5_ret_t (*delete_principal) (void*, krb5_principal);
  52     kadm5_ret_t (*destroy) (void*);
  53     kadm5_ret_t (*flush) (void*);
  54     kadm5_ret_t (*get_principal) (void*, krb5_principal,
  55                                   kadm5_principal_ent_t, uint32_t);
  56     kadm5_ret_t (*get_principals) (void*, const char*, char***, int*);
  57     kadm5_ret_t (*get_privs) (void*, uint32_t*);
  58     kadm5_ret_t (*modify_principal) (void*, kadm5_principal_ent_t, uint32_t);
  59     kadm5_ret_t (*randkey_principal) (void*, krb5_principal, krb5_boolean, int,
  60                                       krb5_key_salt_tuple*, krb5_keyblock**,
  61                                       int*);
  62     kadm5_ret_t (*rename_principal) (void*, krb5_principal, krb5_principal);
  63     kadm5_ret_t (*chpass_principal_with_key) (void *, krb5_principal, int,
  64                                               int, krb5_key_data *);
  65     kadm5_ret_t (*lock) (void *);
  66     kadm5_ret_t (*unlock) (void *);
  67     kadm5_ret_t (*setkey_principal_3) (void *, krb5_principal, krb5_boolean,
  68                                        int, krb5_key_salt_tuple *,
  69                                        krb5_keyblock *, int);
  70     kadm5_ret_t (*prune_principal) (void *, krb5_principal, int);
  71     kadm5_ret_t (*iter_principals) (void*, const char*, int (*)(void *, const char *), void *);
  72     kadm5_ret_t (*dup_context) (void*, void **);
  73 };
  74
  75 typedef struct kadm5_hook_context {
  76     void *dsohandle;
  77     const kadm5_hook_ftable *hook;
  78     void *data;
  79 } kadm5_hook_context;
  80
  81 /* XXX should be integrated */
  82 typedef struct kadm5_common_context {
  83     krb5_context context;
  84     krb5_boolean my_context;
  85     struct kadm_func funcs;
  86     void *data;
  87 } kadm5_common_context;
  88
  89 typedef struct kadm5_log_peer {
  90     int fd;
  91     char *name;
  92     krb5_auth_context ac;
  93     struct kadm5_log_peer *next;
  94 } kadm5_log_peer;
  95
  96 typedef struct kadm5_log_context {
  97     char *log_file;
  98     int log_fd;
  99     int read_only;
 100     int lock_mode;
 101     uint32_t version;
 102     time_t last_time;
 103 #ifndef NO_UNIX_SOCKETS
 104     struct sockaddr_un socket_name;
 105 #else
 106     struct addrinfo *socket_info;
 107 #endif
 108     krb5_socket_t socket_fd;
 109 } kadm5_log_context;
 110
 111 typedef struct kadm5_server_context {
 112     krb5_context context;
 113     krb5_boolean my_context;
 114     struct kadm_func funcs;
 115     /* */
 116     kadm5_config_params config;
 117     HDB *db;
 118     int keep_open;
 119     krb5_principal caller;
 120     unsigned acl_flags;
 121     kadm5_log_context log_context;
 122     size_t num_hooks;
 123     kadm5_hook_context **hooks;
 124 } kadm5_server_context;
 125
 126 typedef struct kadm5_client_context {
 127     krb5_context context;
 128     krb5_boolean my_context;
 129     struct kadm_func funcs;
 130     /* */
 131     krb5_auth_context ac;
 132     char *realm;
 133     char *admin_server;
 134     int kadmind_port;
 135     krb5_socket_t sock;
 136     char *client_name;
 137     char *service_name;
 138     krb5_prompter_fct prompter;
 139     const char *keytab;
 140     krb5_ccache ccache;
 141     kadm5_config_params *realm_params;
 142     char *readonly_admin_server;
 143     int readonly_kadmind_port;
 144     unsigned int want_write:1;
 145     unsigned int connected_to_writable:1;
 146 } kadm5_client_context;
 147
 148 typedef struct kadm5_ad_context {
 149     krb5_context context;
 150     krb5_boolean my_context;
 151     struct kadm_func funcs;
 152     /* */
 153     kadm5_config_params config;
 154     krb5_principal caller;
 155     krb5_ccache ccache;
 156     char *client_name;
 157     char *realm;
 158     void *ldap_conn;
 159     char *base_dn;
 160 } kadm5_ad_context;
 161
 162 /*
 163  * This enum is used in the iprop log file and on the wire in the iprop
 164  * protocol.  DO NOT CHANGE, except to add new op types at the end, and
 165  * look for places in lib/kadm5/log.c to update.
 166  */
 167 enum kadm_ops {
 168     kadm_get,
 169     kadm_delete,
 170     kadm_create,
 171     kadm_rename,
 172     kadm_chpass,
 173     kadm_modify,
 174     kadm_randkey,
 175     kadm_get_privs,
 176     kadm_get_princs,
 177     kadm_chpass_with_key,
 178     kadm_nop,
 179     kadm_prune,
 180     kadm_first = kadm_get,
 181     kadm_last = kadm_prune
 182 };
 183
 184 /* FIXME nop types are currently not implemented */
 185 enum kadm_nop_type {
 186     kadm_nop_plain, /* plain nop, not relevance except as uberblock */
 187     kadm_nop_trunc, /* indicates that the master truncated the log  */
 188     kadm_nop_close  /* indicates that the master closed this log    */
 189 };
 190
 191 enum kadm_iter_opts {
 192     kadm_forward        = 1,
 193     kadm_backward       = 2,
 194     kadm_confirmed      = 4,
 195     kadm_unconfirmed    = 8
 196 };
 197
 198 enum kadm_recover_mode {
 199     kadm_recover_commit,
 200     kadm_recover_replay
 201 };
 202
 203 #define KADMIN_APPL_VERSION "KADM0.1"
 204 #define KADMIN_OLD_APPL_VERSION "KADM0.0"
 205
 206 extern struct heim_plugin_data kadm5_hook_plugin_data;
 207
 208 #include "kadm5-private.h"
 209
 210 #endif /* __kadm5_privatex_h__ */