clarify documentation
[heimdal.git] / lib / kadm5 / private.h
blob7c5b27f1769110f1b9710482ef7996832c1104f8
1 /*
2 * Copyright (c) 1997-2000 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
4 * All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
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.
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.
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.
34 /* $Id$ */
36 #ifndef __kadm5_privatex_h__
37 #define __kadm5_privatex_h__
39 struct kadm_func {
40 kadm5_ret_t (*chpass_principal) (void *, krb5_principal, const char*);
41 kadm5_ret_t (*create_principal) (void*, kadm5_principal_ent_t,
42 uint32_t, const char*);
43 kadm5_ret_t (*delete_principal) (void*, krb5_principal);
44 kadm5_ret_t (*destroy) (void*);
45 kadm5_ret_t (*flush) (void*);
46 kadm5_ret_t (*get_principal) (void*, krb5_principal,
47 kadm5_principal_ent_t, uint32_t);
48 kadm5_ret_t (*get_principals) (void*, const char*, char***, int*);
49 kadm5_ret_t (*get_privs) (void*, uint32_t*);
50 kadm5_ret_t (*modify_principal) (void*, kadm5_principal_ent_t, uint32_t);
51 kadm5_ret_t (*randkey_principal) (void*, krb5_principal,
52 krb5_keyblock**, int*);
53 kadm5_ret_t (*rename_principal) (void*, krb5_principal, krb5_principal);
54 kadm5_ret_t (*chpass_principal_with_key) (void *, krb5_principal,
55 int, krb5_key_data *);
58 /* XXX should be integrated */
59 typedef struct kadm5_common_context {
60 krb5_context context;
61 krb5_boolean my_context;
62 struct kadm_func funcs;
63 void *data;
64 }kadm5_common_context;
66 typedef struct kadm5_log_peer {
67 int fd;
68 char *name;
69 krb5_auth_context ac;
70 struct kadm5_log_peer *next;
71 } kadm5_log_peer;
73 typedef struct kadm5_log_context {
74 char *log_file;
75 int log_fd;
76 uint32_t version;
77 #ifndef NO_UNIX_SOCKETS
78 struct sockaddr_un socket_name;
79 #else
80 struct addrinfo *socket_info;
81 #endif
82 krb5_socket_t socket_fd;
83 } kadm5_log_context;
85 typedef struct kadm5_server_context {
86 krb5_context context;
87 krb5_boolean my_context;
88 struct kadm_func funcs;
89 /* */
90 kadm5_config_params config;
91 HDB *db;
92 krb5_principal caller;
93 unsigned acl_flags;
94 kadm5_log_context log_context;
95 } kadm5_server_context;
97 typedef struct kadm5_client_context {
98 krb5_context context;
99 krb5_boolean my_context;
100 struct kadm_func funcs;
101 /* */
102 krb5_auth_context ac;
103 char *realm;
104 char *admin_server;
105 int kadmind_port;
106 int sock;
107 char *client_name;
108 char *service_name;
109 krb5_prompter_fct prompter;
110 const char *keytab;
111 krb5_ccache ccache;
112 kadm5_config_params *realm_params;
113 }kadm5_client_context;
115 typedef struct kadm5_ad_context {
116 krb5_context context;
117 krb5_boolean my_context;
118 struct kadm_func funcs;
119 /* */
120 kadm5_config_params config;
121 krb5_principal caller;
122 krb5_ccache ccache;
123 char *client_name;
124 char *realm;
125 void *ldap_conn;
126 char *base_dn;
127 } kadm5_ad_context;
129 enum kadm_ops {
130 kadm_get,
131 kadm_delete,
132 kadm_create,
133 kadm_rename,
134 kadm_chpass,
135 kadm_modify,
136 kadm_randkey,
137 kadm_get_privs,
138 kadm_get_princs,
139 kadm_chpass_with_key,
140 kadm_nop
143 #define KADMIN_APPL_VERSION "KADM0.1"
144 #define KADMIN_OLD_APPL_VERSION "KADM0.0"
146 #include "kadm5-private.h"
148 #endif /* __kadm5_privatex_h__ */