aboutsummaryrefslogtreecommitdiff
path: root/src/kim/lib/kim_ui_plugin.c
blob: dd69f007e9b3518b34baf2b468c8891bb099c418 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
/* kim/lib/kim_ui_plugin.c */
/*
 * Copyright 2008 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.
 */

#include "k5-int.h"

#include "kim_private.h"


const char * const *kim_ui_plugin_files = NULL;
#if TARGET_OS_MAC
static const char *kim_ui_plugin_dirs[] = { KRB5_KIM_UI_PLUGIN_BUNDLE_DIR, LIBDIR "/krb5/plugins/kimui", NULL };
#else
static const char *kim_ui_plugin_dirs[] = { LIBDIR "/krb5/plugins/kimui", NULL };
#endif


struct kim_ui_plugin_context {
    krb5_context kcontext;
    struct plugin_dir_handle plugins;
    struct kim_ui_plugin_ftable_v0 *ftable;
    void **ftables;
    void *plugin_context;
};


/* ------------------------------------------------------------------------ */

static void kim_ui_plugin_context_free (kim_ui_plugin_context *io_context)
{
    if (io_context && *io_context) {
        if ((*io_context)->ftables) {
            krb5int_free_plugin_dir_data ((*io_context)->ftables);
        }
        if (PLUGIN_DIR_OPEN (&(*io_context)->plugins)) {
            krb5int_close_plugin_dirs (&(*io_context)->plugins);
        }
        if ((*io_context)->kcontext) {
            krb5_free_context ((*io_context)->kcontext);
        }
        free (*io_context);
        *io_context = NULL;
    }
}

/* ------------------------------------------------------------------------ */

static kim_error kim_ui_plugin_context_allocate (kim_ui_plugin_context *out_context)
{
    kim_error err = KIM_NO_ERROR;
    kim_ui_plugin_context context = NULL;

    if (!err && !out_context) { err = check_error (KIM_NULL_PARAMETER_ERR); }

    if (!err) {
        context = malloc (sizeof (*context));
        if (!context) { err = KIM_OUT_OF_MEMORY_ERR; }
    }

    if (!err) {
        err = krb5_error (NULL, krb5_init_context (&context->kcontext));
    }

    if (!err) {
        PLUGIN_DIR_INIT(&context->plugins);
        context->ftable = NULL;
        context->ftables = NULL;
        context->plugin_context = NULL;

        *out_context = context;
        context = NULL;
    }

    kim_ui_plugin_context_free (&context);

    return check_error (err);
}

#pragma mark -

/* ------------------------------------------------------------------------ */

kim_error kim_ui_plugin_init (kim_ui_context *io_context)
{
    kim_error err = KIM_NO_ERROR;
    kim_ui_plugin_context context = NULL;

    if (!err && !io_context) { err = check_error (KIM_NULL_PARAMETER_ERR); }

    if (!err) {
        err = kim_ui_plugin_context_allocate (&context);
    }

    if (!err) {
        PLUGIN_DIR_INIT(&context->plugins);

        err = krb5_error (context->kcontext,
                          krb5int_open_plugin_dirs (kim_ui_plugin_dirs,
                                                    kim_ui_plugin_files,
                                                    &context->plugins,
                                                    &context->kcontext->err));
    }

    if (!err) {
        err = krb5_error (context->kcontext,
                          krb5int_get_plugin_dir_data (&context->plugins,
                                                       "kim_ui_0",
                                                       &context->ftables,
                                                       &context->kcontext->err));
    }

    if (!err && context->ftables) {
        int i;

        for (i = 0; context->ftables[i]; i++) {
            struct kim_ui_plugin_ftable_v0 *ftable = context->ftables[i];
            context->plugin_context = NULL;

            err = ftable->init (&context->plugin_context);

            if (!err) {
                context->ftable = ftable;
                break; /* use first plugin that initializes correctly */
            }

            err = KIM_NO_ERROR; /* ignore failed plugins */
        }
    }

    if (!err && !context->ftable) {
        err = check_error (KRB5_PLUGIN_NO_HANDLE);
    }

    if (!err) {
        io_context->tcontext = context;
        context = NULL;
    }

    kim_ui_plugin_context_free (&context);

    return check_error (err);
}

/* ------------------------------------------------------------------------ */

kim_error kim_ui_plugin_enter_identity (kim_ui_context *in_context,
                                        kim_options     io_options,
                                        kim_identity   *out_identity,
                                        kim_boolean    *out_change_password)
{
    kim_error err = KIM_NO_ERROR;

    if (!err && !in_context         ) { err = check_error (KIM_NULL_PARAMETER_ERR); }
    if (!err && !io_options         ) { err = check_error (KIM_NULL_PARAMETER_ERR); }
    if (!err && !out_identity       ) { err = check_error (KIM_NULL_PARAMETER_ERR); }
    if (!err && !out_change_password) { err = check_error (KIM_NULL_PARAMETER_ERR); }

    if (!err) {
        kim_ui_plugin_context context = (kim_ui_plugin_context) in_context->tcontext;

        err = context->ftable->enter_identity (context->plugin_context,
                                               io_options,
                                               out_identity,
                                               out_change_password);
    }

    return check_error (err);
}

/* ------------------------------------------------------------------------ */

kim_error kim_ui_plugin_select_identity (kim_ui_context      *in_context,
                                         kim_selection_hints  io_hints,
                                         kim_identity        *out_identity,
                                         kim_boolean         *out_change_password)
{
    kim_error err = KIM_NO_ERROR;

    if (!err && !in_context         ) { err = check_error (KIM_NULL_PARAMETER_ERR); }
    if (!err && !io_hints           ) { err = check_error (KIM_NULL_PARAMETER_ERR); }
    if (!err && !out_identity       ) { err = check_error (KIM_NULL_PARAMETER_ERR); }
    if (!err && !out_change_password) { err = check_error (KIM_NULL_PARAMETER_ERR); }

    if (!err) {
        kim_ui_plugin_context context = (kim_ui_plugin_context) in_context->tcontext;

        err = context->ftable->select_identity (context->plugin_context,
                                                io_hints,
                                                out_identity,
                                                out_change_password);
    }

    return check_error (err);
}

/* ------------------------------------------------------------------------ */

kim_error kim_ui_plugin_auth_prompt (kim_ui_context      *in_context,
                                     kim_identity         in_identity,
                                     kim_prompt_type      in_type,
                                     kim_boolean          in_allow_save_reply,
                                     kim_boolean          in_hide_reply,
                                     kim_string           in_title,
                                     kim_string           in_message,
                                     kim_string           in_description,
                                     char               **out_reply,
                                     kim_boolean         *out_save_reply)
{
    kim_error err = KIM_NO_ERROR;

    if (!err && !in_context ) { err = check_error (KIM_NULL_PARAMETER_ERR); }
    if (!err && !in_identity) { err = check_error (KIM_NULL_PARAMETER_ERR); }
    if (!err && !out_reply  ) { err = check_error (KIM_NULL_PARAMETER_ERR); }
    /* in_title, in_message or in_description may be NULL */

    if (!err) {
        kim_ui_plugin_context context = (kim_ui_plugin_context) in_context->tcontext;

        err = context->ftable->auth_prompt (context->plugin_context,
                                            in_identity,
                                            in_type,
                                            in_allow_save_reply,
                                            in_hide_reply,
                                            in_title,
                                            in_message,
                                            in_description,
                                            out_reply,
                                            out_save_reply);
    }

    return check_error (err);
}

/* ------------------------------------------------------------------------ */

kim_error kim_ui_plugin_change_password (kim_ui_context  *in_context,
                                         kim_identity     in_identity,
                                         kim_boolean      in_old_password_expired,
                                         char           **out_old_password,
                                         char           **out_new_password,
                                         char           **out_verify_password)
{
    kim_error err = KIM_NO_ERROR;

    if (!err && !in_context         ) { err = check_error (KIM_NULL_PARAMETER_ERR); }
    if (!err && !in_identity        ) { err = check_error (KIM_NULL_PARAMETER_ERR); }
    if (!err && !out_old_password   ) { err = check_error (KIM_NULL_PARAMETER_ERR); }
    if (!err && !out_new_password   ) { err = check_error (KIM_NULL_PARAMETER_ERR); }
    if (!err && !out_verify_password) { err = check_error (KIM_NULL_PARAMETER_ERR); }

    if (!err) {
        kim_ui_plugin_context context = (kim_ui_plugin_context) in_context->tcontext;

        err = context->ftable->change_password (context->plugin_context,
                                                in_identity,
                                                in_old_password_expired,
                                                out_old_password,
                                                out_new_password,
                                                out_verify_password);
    }

    return check_error (err);
}

/* ------------------------------------------------------------------------ */

kim_error kim_ui_plugin_handle_error (kim_ui_context *in_context,
                                      kim_identity    in_identity,
                                      kim_error       in_error,
                                      kim_string      in_error_message,
                                      kim_string      in_error_description)
{
    kim_error err = KIM_NO_ERROR;

    if (!err && !in_context          ) { err = check_error (KIM_NULL_PARAMETER_ERR); }
    if (!err && !in_error_message    ) { err = check_error (KIM_NULL_PARAMETER_ERR); }
    if (!err && !in_error_description) { err = check_error (KIM_NULL_PARAMETER_ERR); }

    if (!err) {
        kim_ui_plugin_context context = (kim_ui_plugin_context) in_context->tcontext;

        err = context->ftable->handle_error (context->plugin_context,
                                             in_identity,
                                             in_error,
                                             in_error_message,
                                             in_error_description);
    }

    return check_error (err);
}

/* ------------------------------------------------------------------------ */

void kim_ui_plugin_free_string (kim_ui_context  *in_context,
                                char           **io_string)
{
    kim_error err = KIM_NO_ERROR;

    if (!err && !in_context) { err = check_error (KIM_NULL_PARAMETER_ERR); }
    if (!err && !io_string ) { err = check_error (KIM_NULL_PARAMETER_ERR); }

    if (!err) {
        kim_ui_plugin_context context = (kim_ui_plugin_context) in_context->tcontext;

        context->ftable->free_string (context->plugin_context,
                                      io_string);
    }
 }

/* ------------------------------------------------------------------------ */

kim_error kim_ui_plugin_fini (kim_ui_context *io_context)
{
    kim_error err = KIM_NO_ERROR;

    if (!err && !io_context) { err = check_error (KIM_NULL_PARAMETER_ERR); }

    if (!err) {
        kim_ui_plugin_context context = (kim_ui_plugin_context) io_context->tcontext;

        if (context) {
            err = context->ftable->fini (context->plugin_context);
        }

        if (!err) {
            kim_ui_plugin_context_free (&context);
            io_context->tcontext = NULL;
        }
    }

    return check_error (err);
}