/usr/include/lcas/lcas.h is in lcas-interface 1.3.19-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /**
* Copyright (c) Members of the EGEE Collaboration. 2004-2010.
* See http://www.eu-egee.org/partners/ for details on the copyright
* holders.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*
* Authors:
* 2009-
* Oscar Koeroo <okoeroo@nikhef.nl>
* Mischa Sall\'e <msalle@nikhef.nl>
* David Groep <davidg@nikhef.nl>
* NIKHEF Amsterdam, the Netherlands
* <grid-mw-security@nikhef.nl>
*
* 2007-2009
* Oscar Koeroo <okoeroo@nikhef.nl>
* David Groep <davidg@nikhef.nl>
* NIKHEF Amsterdam, the Netherlands
*
* 2003-2007
* Martijn Steenbakkers <martijn@nikhef.nl>
* Oscar Koeroo <okoeroo@nikhef.nl>
* David Groep <davidg@nikhef.nl>
* NIKHEF Amsterdam, the Netherlands
*
*/
/*!
\file lcas.h
\brief API of the LCAS library
\author Martijn Steenbakkers for the EU DataGrid.
This header contains the declarations of the LCAS library functions:
-# lcas_init(): To initialize the LCAS module
-# lcas_get_fabric_authorization(): to place an authorization request
-# lcas_term(): To cleanly terminate the module
\ingroup LcasInterface
*/
/*!
\defgroup LcasInterface Interface to LCAS (library)
\brief The API is available by including the header lcas.h
*/
#ifndef LCAS_H
#define LCAS_H
#ifndef LCAS_C
# define LCAS_C_STORAGE_CLASS extern
#else
# define LCAS_C_STORAGE_CLASS
#endif
/******************************************************************************
Include header files
******************************************************************************/
#ifndef NOGLOBUS
#include <gssapi.h>
#endif /* NOGLOBUS */
#include "lcas_types.h"
/******************************************************************************
* Module definition
*****************************************************************************/
/******************************************************************************
Function: lcas_init
Description:
Initialize LCAS module:
setup logging, error handling
read from LCAS database the plugins to be loaded
Parameters:
fp: file handle for logging (from gatekeeper)
Returns:
0: initialization succeeded
1: initialization failed
******************************************************************************/
/*!
\fn lcas_init(
FILE* fp
)
\brief Initialize the LCAS module.
The function does the following:
- initialize LCAS module.
- setup logging, error handling (not yet).
- read from LCAS database the plugins to be loaded.
- initialize the plugins
\param fp file handle for logging (from gatekeeper)
\retval 0 initialization succeeded.
\retval 1 initialization failed.
*/
LCAS_C_STORAGE_CLASS int lcas_init(
FILE* fp
);
/******************************************************************************
Function: lcas_init_and_log
Description:
Select logging type
Setup logging, error handling (not yet).
Read from LCAS database the plugins to be loaded.
Initialize the plugins
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)
Returns:
0: initialization succeeded
1: initialization failed
******************************************************************************/
/*!
\fn lcas_init_and_log(
FILE* fp,
unsigned short logtype
)
\brief Initialize the LCAS module.
The function does the following:
- select logging type
- setup logging, error handling (not yet).
- read from LCAS database the plugins to be loaded.
- initialize the plugins
\param 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.
\param logtype type of logging (usrlog and/or syslog)
\retval 0 initialization succeeded.
\retval 1 initialization failed.
*/
LCAS_C_STORAGE_CLASS int lcas_init_and_log(
FILE* fp,
unsigned short logtype
);
/******************************************************************************
Function: lcas_init_and_logfile
Description:
Select logging type
Setup logging by providing a file handle or file name, error handling (not yet).
Read from LCAS database the plugins to be loaded.
Initialize the plugins
Parameters:
logfile: name of logfile
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)
Returns:
0: initialization succeeded
1: initialization failed
******************************************************************************/
/*!
\fn lcas_init_and_logfile(
char * logfile,
FILE* fp,
unsigned short logtype
)
\brief Initialize the LCAS module.
The function does the following:
- select logging type
- setup logging by providing a file handle or file name, error handling (not yet).
- read from LCAS database the plugins to be loaded.
- initialize the plugins
\param logfile name of the logfile
\param 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.
\param logtype type of logging (usrlog and/or syslog)
\retval 0 initialization succeeded.
\retval 1 initialization failed.
*/
LCAS_C_STORAGE_CLASS int lcas_init_and_logfile(
char * logfile,
FILE* fp,
unsigned short logtype
);
/******************************************************************************
Function: lcas_term
Description:
Terminate LCAS module:
Parameters:
Returns:
0: termination succeeded
1: termination failed
******************************************************************************/
/*!
\fn lcas_term()
\brief Terminate the LCAS module.
The function does the following:
- terminate the LCAS module
- terminate the plugins
\retval 0 initialization succeeded.
\retval 1 initialization failed.
*/
LCAS_C_STORAGE_CLASS int lcas_term(void);
/******************************************************************************
Function: lcas_get_fabric_authorization
Description:
Call LCAS in order to get authorization on the local fabric
Parameters:
user_cred : user globus credential handle
request: RSL string
Returns:
0: authorization succeeded
1: authorization failed
******************************************************************************/
#if ALLOW_EMPTY_CREDENTIALS
/*!
\fn lcas_get_fabric_authorization(
char * user_dn_tmp,
gss_cred_id_t user_cred,
lcas_request_t request
)
\brief submit authorization request to the LCAS
This function calls the plugins for authorization.
As a back-up for empty credentials the user DN may be specified as well.
For this \b ALLOW_EMPTY_CREDENTIALS should be defined.
\param user_dn_tmp user DN
\param user_cred GSS/GSI user credential
\param request authorization request as RSL string
\retval 0 initialization succeeded.
\retval 1 initialization failed.
*/
LCAS_C_STORAGE_CLASS int lcas_get_fabric_authorization(
char * user_dn_tmp,
gss_cred_id_t user_cred,
lcas_request_t request
);
#else
/*!
\fn lcas_get_fabric_authorization(
gss_cred_id_t user_cred,
lcas_request_t request
)
\brief submit authorization request to the LCAS
This function calls the plugins for authorization.
\param user_cred GSS/GSI user credential
\param request authorization request as RSL string
\retval 0 initialization succeeded.
\retval 1 initialization failed.
*/
LCAS_C_STORAGE_CLASS int lcas_get_fabric_authorization(
gss_cred_id_t user_cred,
lcas_request_t request
);
#endif
LCAS_C_STORAGE_CLASS int getMajorVersionNumber(void);
LCAS_C_STORAGE_CLASS int getMinorVersionNumber(void);
LCAS_C_STORAGE_CLASS int getPatchVersionNumber(void);
#endif /* LCAS_H */
/******************************************************************************
CVS Information:
$Source: /srv/home/dennisvd/svn/mw-security/lcas/interface/lcas.h,v $
$Date: 2010-05-03 10:43:18 $
$Revision: 1.8 $
$Author: okoeroo $
******************************************************************************/
|