Grid Community Toolkit  6.2.1566487665 (tag: v6.2.20190829)
globus_gss_assist.h
Go to the documentation of this file.
1 /*
2  * Copyright 1999-2006 University of Chicago
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef _GLOBUS_GSS_ASSIST_H
18 #define _GLOBUS_GSS_ASSIST_H
19 
25 #include "gssapi.h"
26 
27 #include <stdio.h>
28 #include <stdlib.h>
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 #ifndef GLOBUS_GLOBAL_DOCUMENT_SET
35 
39 #endif
40 
94 #define GLOBUS_GSI_GSS_ASSIST_MODULE (&globus_i_gsi_gss_assist_module)
95 
96 extern
97 globus_module_descriptor_t globus_i_gsi_gss_assist_module;
98 
99 #define _GASL(s) globus_common_i18n_get_string( \
100  GLOBUS_GSI_GSS_ASSIST_MODULE, \
101  s)
102 #include "globus_gss_assist_constants.h"
103 
104 
105 #define GLOBUS_GSS_ASSIST_TOKEN_ERR_MALLOC 1
106 #define GLOBUS_GSS_ASSIST_TOKEN_ERR_BAD_SIZE 2
107 #define GLOBUS_GSS_ASSIST_TOKEN_EOF 3
108 #define GLOBUS_GSS_ASSIST_TOKEN_NOT_FOUND 4
109 
110 /* for kerberos v5.1.0.5 compatibility we need this */
111 #ifndef GSS_C_NO_NAME
112 #define GSS_C_NO_NAME ((gss_name_t *) 0)
113 #define GSS_ASSIST_KRB5_HACK
114 #endif
115 
116 /* for the globus_gss_assist_ex flags: */
117 
118 #define GLOBUS_GSS_ASSIST_EX_SEND_WITHOUT_LENGTH 1
119 
120 typedef struct globus_gss_assist_ex_st
121 {
122  void * arg;
123  int flags;
124 } globus_gss_assist_ex;
125 
136 extern int
137 globus_gss_assist_token_get_fd(
138  void * arg,
139  void ** bufp,
140  size_t * sizep);
141 
142 extern int
143 globus_gss_assist_token_send_fd(
144  void * arg,
145  void * buf,
146  size_t size);
147 
148 extern int
149 globus_gss_assist_token_send_fd_ex(
150  void * arg,
151  void * buf,
152  size_t size);
153 
154 extern int
155 globus_gss_assist_token_send_fd_without_length(
156  void * arg,
157  void * buf,
158  size_t size);
159 
169 extern OM_uint32
170 globus_gss_assist_acquire_cred(
171  OM_uint32 *, /* minor_status */
172  gss_cred_usage_t, /* cred_usage */
173  gss_cred_id_t * /* output_cred_handle */);
174 
175 extern
176 OM_uint32
177 globus_gss_assist_read_vhost_cred_dir(
178  OM_uint32 *minor_status,
179  const char *dir,
180  gss_cred_id_t **output_credentials_array,
181  size_t *output_credentials_array_size);
182 
183 extern OM_uint32
184 globus_gss_assist_acquire_cred_dir(
185  OM_uint32 *, /* minor_status */
186  gss_cred_usage_t, /* cred_usage */
187  gss_cred_id_t ** /* output_cred_handle */,
188  size_t);
189 /*
190  * globus_gss_assist_acquire_cred_ext, assist with the gss_acquire_cred
191  */
192 extern OM_uint32
193 globus_gss_assist_acquire_cred_ext(
194  OM_uint32 *, /* minor_status */
195  char *, /* desired_name_char */
196  OM_uint32, /* time_req */
197  const gss_OID_set, /* desired_mechs */
198  gss_cred_usage_t, /* cred_usage */
199  gss_cred_id_t *, /* output_cred_handle */
200  gss_OID_set *, /* actual_mechs */
201  OM_uint32 * /* time_rec */);
202 
215 extern OM_uint32
216 globus_gss_assist_accept_sec_context(
217  OM_uint32 *, /* minor_status */
218  gss_ctx_id_t *, /* context_handle */
219  const gss_cred_id_t, /* acceptor_cred_handle */
220  char **, /* src_name as char ** */
221  OM_uint32 *, /* ret_flags */
222  int *, /* user_to_user_flag */
223  int *, /* token_status */
224  gss_cred_id_t *, /* delegated_cred_handle */
225  int (* get_token)(void *, void **, size_t *),
226  void * get_context,
227  int (* send_token)(void *, void *, size_t),
228  void * send_context);
229 
230 /*
231  * globus_gss_assist_accept_sec_context_async - async version of
232  * globus_gss_assist_accept_sec_context().
233  */
234 extern OM_uint32
235 globus_gss_assist_accept_sec_context_async(
236  OM_uint32 * minor_status,
237  gss_ctx_id_t * context_handle,
238  const gss_cred_id_t cred_handle,
239  char ** src_name_char,
240  OM_uint32 * ret_flags,
241  int * user_to_user_flag,
242  void * input_buffer,
243  size_t input_buffer_len,
244  void ** output_bufferp,
245  size_t * output_buffer_lenp,
246  gss_cred_id_t * delegated_cred_handle);
247 
248 /*
249  * globus_gss_assist_init_sec_context - takes care of looping
250  * over multiple tokens using the get and send tokens
251  * routines
252  */
253 extern OM_uint32
254 globus_gss_assist_init_sec_context(
255  OM_uint32 *, /* minor_status */
256  const gss_cred_id_t, /* initiator_cred_handle */
257  gss_ctx_id_t *, /* context_handle */
258  char *, /* target_name as char * */
259  OM_uint32, /* req_flags */
260  OM_uint32 *, /* ret_flags */
261  int *, /* token_status */
262  int (* get_token)(void *, void **, size_t *),
263  void * get_arg,
264  int (* send_token)(void *, void *, size_t),
265  void * send_arg);
266 
267 /*
268  * globus_gss_assist_init_sec_context_async - async version of
269  * globus_gss_assist_init_sec_context().
270  */
271 extern OM_uint32
272 globus_gss_assist_init_sec_context_async(
273  OM_uint32 * minor_status,
274  const gss_cred_id_t cred_handle,
275  gss_ctx_id_t * context_handle,
276  char * target_name_char,
277  OM_uint32 req_flags,
278  OM_uint32 * ret_flags,
279  void * input_buffer,
280  size_t input_buffer_len,
281  void ** output_bufferp,
282  size_t * output_buffer_lenp);
283 
293 extern OM_uint32
294 globus_gss_assist_display_status(
295  FILE *, /* where to print */
296  char *, /* comment */
297  OM_uint32, /* major_status */
298  OM_uint32, /* minor_status */
299  int /* token_status */);
300 
301 extern OM_uint32
302 globus_gss_assist_display_status_str(
303  char **, /* string returned with newlines */
304  char *, /* comment */
305  OM_uint32, /* major_status */
306  OM_uint32, /* minor_status */
307  int /* token_status */);
308 
309 /*
310  * globus_gss_assist_wrap_send - used to wrap a
311  * simple message and send it
312  */
313 extern OM_uint32
314 globus_gss_assist_wrap_send(
315  OM_uint32 * minor_status,
316  const gss_ctx_id_t context_handle,
317  char * data,
318  size_t length,
319  int * token_status,
320  int (*gss_assist_send_token)(void *, void *, size_t),
321  void * gss_assist_send_context,
322  FILE * fperr);
323 
324 /*
325  * globus_gss_assist_get_unwrap - used to get and unwrap a message
326  */
327 extern OM_uint32
328 globus_gss_assist_get_unwrap(
329  OM_uint32 * minor_status,
330  const gss_ctx_id_t context_handle,
331  char ** data,
332  size_t * length,
333  int * token_status,
334  int (*gss_assist_get_token)(void *, void **, size_t *),
335  void * gss_assist_get_context,
336  FILE * fperr);
337 
338 /*
339  * globus_gss_assist_will_handle_restrictions - used to tell OpenSSL
340  * that the application will deal with the restrictions extension
341  */
342 OM_uint32
343 globus_gss_assist_will_handle_restrictions(
344  OM_uint32 * minor_status,
345  gss_ctx_id_t * context_handle);
346 
347 
348 /*
349  * globus_gss_assist_import_sec_context - read a security context
350  */
351 extern OM_uint32
352 globus_gss_assist_export_sec_context(
353  OM_uint32 * minor_status,
354  gss_ctx_id_t * context_handle,
355  int * token_status,
356  int fdp,
357  FILE * fperr);
358 
359 /*
360  * globus_gss_assist_import_sec_context - read a security context
361  */
362 extern OM_uint32
363 globus_gss_assist_import_sec_context(
364  OM_uint32 * minor_status,
365  gss_ctx_id_t * context_handle,
366  int * token_status,
367  int fdp,
368  FILE * fperr);
369 
370 
371 globus_result_t
372 globus_gss_assist_authorization_host_name(
373  char * hostname,
374  gss_name_t * authorization_hostname);
375 
386 extern int
387 globus_gss_assist_gridmap(
388  char * globusidp,
389  char ** useridp);
390 
391 extern int
392 globus_gss_assist_userok(
393  char * globusid,
394  char * userid);
395 
396 extern int
397 globus_gss_assist_map_local_user(
398  char * local_user,
399  char ** globusidp);
400 
401 globus_result_t
402 globus_gss_assist_lookup_all_globusid(
403  char * username,
404  char ** dns[],
405  int * dn_count);
406 
407 globus_result_t
408 globus_gss_assist_map_and_authorize(
409  gss_ctx_id_t context,
410  char * service,
411  char * desired_identity,
412  char * identity_buffer,
413  unsigned int identity_buffer_length);
414 
415 globus_result_t
416 globus_gss_assist_map_and_authorize_sharing(
417  char * shared_user_certificate,
418  gss_ctx_id_t context,
419  char * desired_identity,
420  char * identity_buffer,
421  unsigned int identity_buffer_length);
422 
423 
438 #define GlobusGssAssistFreeDNArray(dn_a) \
439 { \
440  int __ctr = 0; \
441  while(dn_a[__ctr] != NULL) \
442  { \
443  free(dn_a[__ctr]); \
444  __ctr++; \
445  } \
446  free(dn_a); \
447 }
448 
449 
450 #ifdef __cplusplus
451 }
452 #endif
453 
454 #endif /* _GLOBUS_GSS_ASSIST_H */
globus_gss_assist_lookup_all_globusid
globus_result_t globus_gss_assist_lookup_all_globusid(char *username, char **dns[], int *dn_count)
Look up all Grid IDs associated with a local user ID.
Definition: gridmap.c:1769
globus_gss_assist_display_status_str
OM_uint32 globus_gss_assist_display_status_str(char **, char *, OM_uint32, OM_uint32, int)
Definition: display.c:173
globus_gss_assist_userok
int globus_gss_assist_userok(char *globusid, char *userid)
Gridmap entry existence check.
Definition: gridmap.c:699
globus_gss_assist_accept_sec_context_async
OM_uint32 globus_gss_assist_accept_sec_context_async(OM_uint32 *minor_status, gss_ctx_id_t *context_handle, const gss_cred_id_t cred_handle, char **src_name_char, OM_uint32 *ret_flags, int *user_to_user_flag, void *input_buffer, size_t input_buffer_len, void **output_bufferp, size_t *output_buffer_lenp, gss_cred_id_t *delegated_cred_handle)
Accept a Security Context Without Blocking.
Definition: accept.c:323
globus_gss_assist_get_unwrap
OM_uint32 globus_gss_assist_get_unwrap(OM_uint32 *minor_status, const gss_ctx_id_t context_handle, char **data, size_t *length, int *token_status, int(*gss_assist_get_token)(void *, void **, size_t *), void *gss_assist_get_context, FILE *fperr)
Get Unwrap.
Definition: unwrap.c:60
globus_gss_assist_acquire_cred
OM_uint32 globus_gss_assist_acquire_cred(OM_uint32 *, gss_cred_usage_t, gss_cred_id_t *)
Definition: acquire.c:67
globus_gss_assist_accept_sec_context
OM_uint32 globus_gss_assist_accept_sec_context(OM_uint32 *, gss_ctx_id_t *, const gss_cred_id_t, char **, OM_uint32 *, int *, int *, gss_cred_id_t *, int(*get_token)(void *, void **, size_t *), void *get_context, int(*send_token)(void *, void *, size_t), void *send_context)
Accept a Security Context.
Definition: accept.c:80
globus_gss_assist_import_sec_context
OM_uint32 globus_gss_assist_import_sec_context(OM_uint32 *minor_status, gss_ctx_id_t *context_handle, int *token_status, int fdp, FILE *fperr)
Definition: import_sec_context.c:51
globus_gss_assist_will_handle_restrictions
OM_uint32 globus_gss_assist_will_handle_restrictions(OM_uint32 *minor_status, gss_ctx_id_t *context_handle)
Definition: set_sec_context_opts.c:45
globus_gss_assist_acquire_cred_ext
OM_uint32 globus_gss_assist_acquire_cred_ext(OM_uint32 *, char *, OM_uint32, const gss_OID_set, gss_cred_usage_t, gss_cred_id_t *, gss_OID_set *, OM_uint32 *)
Definition: acquire.c:95
globus_gss_assist_token_send_fd
int globus_gss_assist_token_send_fd(void *arg, void *buf, size_t size)
Send token via a FILE *.
Definition: tokens_f.c:247
globus_gss_assist_map_and_authorize_sharing
globus_result_t globus_gss_assist_map_and_authorize_sharing(char *shared_user_certificate, gss_ctx_id_t context, char *desired_identity, char *identity_buffer, unsigned int identity_buffer_length)
Authorize a particular credential for shared access.
Definition: gridmap.c:2126
globus_gss_assist_export_sec_context
OM_uint32 globus_gss_assist_export_sec_context(OM_uint32 *minor_status, gss_ctx_id_t *context_handle, int *token_status, int fdp, FILE *fperr)
Definition: export_sec_context.c:52
globus_gss_assist_wrap_send
OM_uint32 globus_gss_assist_wrap_send(OM_uint32 *minor_status, const gss_ctx_id_t context_handle, char *data, size_t length, int *token_status, int(*gss_assist_send_token)(void *, void *, size_t), void *gss_assist_send_context, FILE *fperr)
Wrap.
Definition: wrap.c:62
globus_gss_assist_read_vhost_cred_dir
OM_uint32 globus_gss_assist_read_vhost_cred_dir(OM_uint32 *minor_status, const char *dir, gss_cred_id_t **output_credentials_array, size_t *output_credentials_array_size)
Acquire all GSSAPI credentials in a directory.
Definition: read_vhost_cred_dir.c:42
globus_gss_assist_map_local_user
int globus_gss_assist_map_local_user(char *local_user, char **globusidp)
Look up the default Grid identity associated with a local user name.
Definition: gridmap.c:836
globus_gss_assist_init_sec_context
OM_uint32 globus_gss_assist_init_sec_context(OM_uint32 *, const gss_cred_id_t, gss_ctx_id_t *, char *, OM_uint32, OM_uint32 *, int *, int(*get_token)(void *, void **, size_t *), void *get_arg, int(*send_token)(void *, void *, size_t), void *send_arg)
Definition: init.c:77
globus_gss_assist_token_send_fd_ex
int globus_gss_assist_token_send_fd_ex(void *arg, void *buf, size_t size)
Send a token to a FILE *.
Definition: tokens_f.c:319
globus_result_t
uint32_t globus_result_t
Definition: globus_types.h:99
globus_gss_assist_init_sec_context_async
OM_uint32 globus_gss_assist_init_sec_context_async(OM_uint32 *minor_status, const gss_cred_id_t cred_handle, gss_ctx_id_t *context_handle, char *target_name_char, OM_uint32 req_flags, OM_uint32 *ret_flags, void *input_buffer, size_t input_buffer_len, void **output_bufferp, size_t *output_buffer_lenp)
Definition: init.c:336
globus_gss_assist_token_get_fd
int globus_gss_assist_token_get_fd(void *arg, void **bufp, size_t *sizep)
Get token from a FILE *.
Definition: tokens_f.c:50
globus_gss_assist_gridmap
int globus_gss_assist_gridmap(char *globusidp, char **useridp)
Look up the default mapping for a Grid identity in a gridmap file.
Definition: gridmap.c:552
globus_gss_assist_display_status
OM_uint32 globus_gss_assist_display_status(FILE *, char *, OM_uint32, OM_uint32, int)
Definition: display.c:125
globus_gss_assist_map_and_authorize
globus_result_t globus_gss_assist_map_and_authorize(gss_ctx_id_t context, char *service, char *desired_identity, char *identity_buffer, unsigned int identity_buffer_length)
Authorize the peer of a security context to use a service.
Definition: gridmap.c:1952
globus_gss_assist_authorization_host_name
globus_result_t globus_gss_assist_authorization_host_name(char *hostname, gss_name_t *authorization_hostname)
Definition: hostname.c:47
globus_gss_assist_constants.h
Globus GSI GSS Assist Library.
globus_module_descriptor_s
Module Descriptor.
Definition: globus_module.h:71
globus_gss_assist_token_send_fd_without_length
int globus_gss_assist_token_send_fd_without_length(void *arg, void *buf, size_t size)
Send token to a FILE *.
Definition: tokens_f.c:276
Generated by   doxygen 1.8.15