Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

lcmaps.h File Reference

API of the LCMAPS library. More...

#include <gssapi.h>
#include "lcmaps_types.h"

Go to the source code of this file.

Functions

int lcmaps_init (FILE *fp)
 Initialize the LCMAPS module. More...

int lcmaps_init_and_log (FILE *fp, unsigned short logtype)
 Initialize the LCMAPS module. More...

int lcmaps_term ()
 Terminate the LCMAPS module. More...

int lcmaps_run (gss_cred_id_t user_cred, lcmaps_request_t request)
 let LCMAPS handle the user mapping. More...

int lcmaps_run_and_return_username (gss_cred_id_t user_cred, lcmaps_request_t request, char **usernamep, int npols, char **policynames)
 let LCMAPS handle the user mapping and return user name. More...

int lcmaps_run_without_credentials (char *user_dn_tmp)
 do the user mapping without credentials, only the user DN. More...


Detailed Description

API of the LCMAPS library.

Author:
Martijn Steenbakkers for the EU DataGrid.
This header contains the declarations of the LCMAPS library functions:
  1. lcmaps_init(): To initialize the LCMAPS module
  2. lcmaps_run(): To do the user mapping
  3. lcmaps_run_without_credentials(): To do the user mapping, without credentials
  4. lcmaps_term(): To cleanly terminate the module

Definition in file lcmaps.h.


Function Documentation

lcmaps_init FILE *    fp
 

Initialize the LCMAPS module.

The function does the following:

  • initialize LCMAPS module.
  • setup logging, error handling (not yet).
  • start PluginManager
Parameters:
fp  file handle for logging (from gatekeeper or other previously opened file handle) If the file handle is zero, assume that only syslogging is requested
Return values:
0  initialization succeeded.
1  initialization failed.

Definition at line 180 of file lcmaps.c.

lcmaps_init_and_log FILE *    fp,
unsigned short    logtype
 

Initialize the LCMAPS module.

The function does the following:

  • initialize LCMAPS module.
  • setup logging, error handling (not yet).
  • start PluginManager
Parameters:
fp  file handle for logging (from gatekeeper or other previously opened file handle) If the file handle is zero, assume that only syslogging is requested
logtype  type of logging (usrlog and/or syslog)
Return values:
0  initialization succeeded.
1  initialization failed.

Definition at line 115 of file lcmaps.c.

References lcmaps_request_t.

lcmaps_run gss_cred_id_t    user_cred,
lcmaps_request_t    request
 

let LCMAPS handle the user mapping.

This function runs the PluginManager for user mapping.

Parameters:
request  authorization request in RSL (later JDL)
user_cred  GLOBUS user credential
Return values:
0  mapping succeeded.
1  mapping failed.

Definition at line 231 of file lcmaps.c.

lcmaps_run_and_return_username gss_cred_id_t    user_cred,
lcmaps_request_t    request,
char **    usernamep,
int    npols,
char **    policynames
 

let LCMAPS handle the user mapping and return user name.

do the user mapping based on the provided list of policies (first successful policy found in the lcmaps policy file (lcmaps.db) will result in the user mapping) and return user name (needed for e.g. GridFTP)

Parameters:
request  authorization request in RSL (later JDL)
user_cred  GLOBUS user credential
usernamep  pointer to user name (to be freed by calling application). Note: usernamep should be non-NULL at the start !
npols  number of policies to be considered for evaluation
policynames  the names of the policies to be considered for evaluation
Return values:
0  mapping succeeded.
1  mapping failed.

Definition at line 331 of file lcmaps.c.

lcmaps_run_without_credentials char *    user_dn_tmp
 

do the user mapping without credentials, only the user DN.

This function runs the PluginManager for user mapping without credentials.

Parameters:
user_dn_tmp  user DN
Return values:
0  mapping succeeded.
1  mapping failed.

Definition at line 442 of file lcmaps.c.

lcmaps_term  
 

Terminate the LCMAPS module.

The function does the following:

  • terminate the LCMAPS module
  • terminate the plugins
Return values:
0  termination succeeded.
1  termination failed.

Definition at line 512 of file lcmaps.c.


Generated on Sat Oct 2 02:18:27 2004 for edg-lcmaps by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002