VOMS C API 1.5.0
Loading...
Searching...
No Matches
voms_apic.h
Go to the documentation of this file.
1/*********************************************************************
2 *
3 * Authors: Vincenzo Ciaschini - Vincenzo.Ciaschini@cnaf.infn.it
4 *
5 * Copyright (c) Members of the EGEE Collaboration. 2004-2010.
6 * See http://www.eu-egee.org/partners/ for details on the copyright holders.
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 *
20 * Parts of this code may be based upon or even include verbatim pieces,
21 * originally written by other people, in which case the original header
22 * follows.
23 *
24 *********************************************************************/
25
26#ifndef VOMS_APIC_H
27#define VOMS_APIC_H
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
33#define NOGLOBUS
34#if !(defined(GSSAPI_H_) || defined(_GSSAPI_H) || defined(_GSSAPI_H_))
35typedef void * gss_cred_id_t;
36typedef void * gss_ctx_id_t;
37#endif
38
39#include <openssl/x509.h>
40#include <time.h>
41
42#include "newformat.h"
43
44/*#include "voms_api.h"*/
45
48struct data {
49 char *group;
50 char *role;
51 char *cap;
52};
53
54struct attribute {
55 const char *name;
56 const char *value;
57 const char *qualifier;
58};
59
60struct contactdata {
63 char *nick;
64 char *host;
65 char *contact;
66 char *vo;
67 int port;
68 char *reserved;
69 int version;
70};
71
75#define TYPE_NODATA 0
76#define TYPE_STD 1
77#define TYPE_CUSTOM 2
80struct voms {
81 int siglen;
82 char *signature;
83 char *user;
84 char *userca;
85 char *server;
86 char *serverca;
87 char *voname;
88 char *uri;
89 char *date1;
90 char *date2;
91 int type;
92 struct data **std;
93 char *custom;
96 char **fqan;
97 char *serial;
99 /* Fields below this line are reserved. */
100 AC *ac;
101 X509 *holder;
102};
103
104
105#define RECURSE_CHAIN 0
106#define RECURSE_NONE 1
107
108#define VERIFY_FULL 0xffffffff
109#define VERIFY_NONE 0x00000000
110#define VERIFY_DATE 0x00000001
111#define VERIFY_NOTARGET 0x00000002
112#define VERIFY_KEY 0x00000004
113#define VERIFY_SIGN 0x00000008
114#define VERIFY_ORDER 0x00000010
115#define VERIFY_ID 0x00000020
116#define VERIFY_CERTLIST 0x00000040
120#define VERR_NONE 0
121#define VERR_NOSOCKET 1
122#define VERR_NOIDENT 2
123#define VERR_COMM 3
124#define VERR_PARAM 4
125#define VERR_NOEXT 5
126#define VERR_NOINIT 6
127#define VERR_TIME 7
128#define VERR_IDCHECK 8
130#define VERR_EXTRAINFO 9
131#define VERR_FORMAT 10
132#define VERR_NODATA 11
133#define VERR_PARSE 12
134#define VERR_DIR 13
135#define VERR_SIGN 14
136#define VERR_SERVER 15
137#define VERR_MEM 16
138#define VERR_VERIFY 17
139#define VERR_TYPE 18
140#define VERR_ORDER 19
141#define VERR_SERVERCODE 20
142#define VERR_NOTAVAIL 21
144struct vomsdata {
145 char *cdir;
146 char *vdir;
147 struct voms **data;
150 char *workvo;
161 int volen;
163 /* Fields below this line are reserved. */
164 struct vomsdata *real;
165};
166
167extern struct contactdata **VOMS_FindByAlias(struct vomsdata *vd, char *alias,
168 char *system, char *user,
169 int *error);
187extern struct contactdata **VOMS_FindByVO(struct vomsdata *vd, char *vo,
188 char *system, char *user,
189 int *error);
207extern void VOMS_DeleteContacts(struct contactdata **list);
210extern struct vomsdata *VOMS_Init(char *voms, char *cert);
224extern struct voms *VOMS_Copy(struct voms *v, int *error);
232extern struct vomsdata *VOMS_CopyAll(struct vomsdata *vd, int *error);
240extern void VOMS_Delete(struct voms *v);
243extern int VOMS_AddTarget(struct vomsdata *vd, char *target, int *error);
248extern void VOMS_FreeTargets(struct vomsdata *vd, int *error);
252extern char *VOMS_ListTargets(struct vomsdata *vd, int *error); /*< Gets the list of targets for the AC.
253 \param vd The vomsdata structure.
254 \param error RETURN PARAMETER: qualifies the error message. */
255
256extern int VOMS_SetVerificationType(int type, struct vomsdata *vd, int *error); /* Sets the verification type.
257 \param type. The verification type.
258 \param vd The vomsdata structure.
259 \param error RETURN PARAMETER: qualifies the error message. */
260
261extern int VOMS_SetLifetime(int length, struct vomsdata *vd,
262 int *error);
269extern void VOMS_Destroy(struct vomsdata *vd);
272extern int VOMS_ResetOrder(struct vomsdata *vd, int *error);
278extern int VOMS_Ordering(char *order, struct vomsdata *vd, int *error);
288extern int VOMS_Contact(char *hostname, int port, char *servsubject,
289 char *command, struct vomsdata *vd, int *error);
302extern int VOMS_ContactRaw(char *hostname, int port, char *servsubject,
303 char *command, void **data, int *datalen, int *version,
304 struct vomsdata *vd, int *error);
319extern int VOMS_Retrieve(X509 *cert, STACK_OF(X509) *chain, int how,
320 struct vomsdata *vd, int *error);
332extern int VOMS_Import(char *buffer, int buflen, struct vomsdata *vd, int *error);
343extern int VOMS_Export(char **buffer, int *buflen, struct vomsdata *vd, int *error);
350extern struct voms *VOMS_DefaultData(struct vomsdata *vd, int *error);
358extern char *VOMS_ErrorMessage(struct vomsdata *vd, int error, char *buffer, int len);
368extern int VOMS_RetrieveEXT(X509_EXTENSION *ext, struct vomsdata *vd, int *error);
374extern int VOMS_RetrieveFromCred(gss_cred_id_t cred, int how, struct vomsdata *vd, int *error);
381extern int VOMS_RetrieveFromFile(FILE *file, int how, struct vomsdata *vd, int *error);
388extern int VOMS_RetrieveFromCtx(gss_ctx_id_t ctx, int how, struct vomsdata *vd, int *error);
395extern int VOMS_RetrieveFromProxy(int how, struct vomsdata *vd, int *error);
401extern int VOMS_RetrieveFromAC(AC*ac, struct vomsdata *vd, int *error);
407extern int VOMS_GetAttributeSourcesNumber(struct voms *v, struct vomsdata *vd, int *error);
408extern int VOMS_GetAttributeSourceHandle(struct voms *v, int num, struct vomsdata *vd, int *error);
409extern const char *VOMS_GetAttributeGrantor(struct voms *v, int handle, struct vomsdata *vd, int *error);
410extern int VOMS_GetAttributesNumber(struct voms *v, int handle, struct vomsdata *vd, int *error);
411extern int VOMS_GetAttribute(struct voms *v, int handle, int num, struct attribute *at, struct vomsdata *vd, int *error);
412
413extern struct vomsdata *VOMS_Duplicate(struct vomsdata *vd);
414extern AC *VOMS_GetAC(struct voms *v);
415
416extern int getMajorVersionNumber(void);
417extern int getMinorVersionNumber(void);
418extern int getPatchVersionNumber(void);
419
420extern int VOMS_SetVerificationTime(time_t verificationtime, struct vomsdata *vd, int *error);
421extern char **VOMS_GetTargetsList(struct voms *v, struct vomsdata *vd, int *error);
422extern void VOMS_FreeTargetsList(char **);
423
424extern int VOMS_SetTimeout(int t, struct vomsdata *vd, int *error);
425extern int VOMS_LoadCredentials(X509 *cert, EVP_PKEY *pkey, STACK_OF(X509)* chain, struct vomsdata *vd, int *error);
426
427#ifdef __cplusplus
428}
429#endif
430
431#endif
432
433
const char * value
Definition voms_apic.h:56
const char * name
Definition voms_apic.h:55
const char * qualifier
Definition voms_apic.h:57
The type of data returned.
Definition voms_apic.h:60
char * vo
Definition voms_apic.h:66
char * nick
Definition voms_apic.h:63
char * host
Definition voms_apic.h:64
char * contact
Definition voms_apic.h:65
char * reserved
Definition voms_apic.h:68
User's characteristics: can be repeated.
Definition voms_apic.h:48
char * cap
Definition voms_apic.h:51
char * group
Definition voms_apic.h:49
char * role
Definition voms_apic.h:50
char * signature
Definition voms_apic.h:82
char * date1
Definition voms_apic.h:89
char * user
Definition voms_apic.h:83
int datalen
Definition voms_apic.h:94
char * server
Definition voms_apic.h:85
int version
Definition voms_apic.h:95
int siglen
Definition voms_apic.h:81
int type
Definition voms_apic.h:91
char * custom
Definition voms_apic.h:93
char * voname
Definition voms_apic.h:87
AC * ac
Definition voms_apic.h:100
char * date2
Definition voms_apic.h:90
char * serverca
Definition voms_apic.h:86
char * uri
Definition voms_apic.h:88
char ** fqan
Definition voms_apic.h:96
char * serial
Definition voms_apic.h:97
X509 * holder
Definition voms_apic.h:101
struct data ** std
Definition voms_apic.h:92
char * userca
Definition voms_apic.h:84
char * cdir
Definition voms_apic.h:145
struct vomsdata * real
Definition voms_apic.h:164
char * vdir
Definition voms_apic.h:146
int volen
Definition voms_apic.h:161
char * extra_data
Definition voms_apic.h:152
struct voms ** data
Definition voms_apic.h:147
int extralen
Definition voms_apic.h:162
char * workvo
Definition voms_apic.h:150
struct vomsdata * VOMS_Duplicate(struct vomsdata *vd)
struct contactdata ** VOMS_FindByAlias(struct vomsdata *vd, char *alias, char *system, char *user, int *error)
struct vomsdata * VOMS_CopyAll(struct vomsdata *vd, int *error)
const char * VOMS_GetAttributeGrantor(struct voms *v, int handle, struct vomsdata *vd, int *error)
char ** VOMS_GetTargetsList(struct voms *v, struct vomsdata *vd, int *error)
int VOMS_RetrieveFromFile(FILE *file, int how, struct vomsdata *vd, int *error)
int VOMS_LoadCredentials(X509 *cert, EVP_PKEY *pkey, STACK_OF(X509) *chain, struct vomsdata *vd, int *error)
int getMajorVersionNumber(void)
int VOMS_ResetOrder(struct vomsdata *vd, int *error)
int VOMS_RetrieveEXT(X509_EXTENSION *ext, struct vomsdata *vd, int *error)
int getMinorVersionNumber(void)
void VOMS_DeleteContacts(struct contactdata **list)
int VOMS_RetrieveFromAC(AC *ac, struct vomsdata *vd, int *error)
int VOMS_SetTimeout(int t, struct vomsdata *vd, int *error)
int getPatchVersionNumber(void)
int VOMS_GetAttributesNumber(struct voms *v, int handle, struct vomsdata *vd, int *error)
int VOMS_Import(char *buffer, int buflen, struct vomsdata *vd, int *error)
char * VOMS_ListTargets(struct vomsdata *vd, int *error)
void * gss_cred_id_t
Definition voms_apic.h:35
int VOMS_RetrieveFromCred(gss_cred_id_t cred, int how, struct vomsdata *vd, int *error)
int VOMS_RetrieveFromCtx(gss_ctx_id_t ctx, int how, struct vomsdata *vd, int *error)
int VOMS_GetAttribute(struct voms *v, int handle, int num, struct attribute *at, struct vomsdata *vd, int *error)
int VOMS_Export(char **buffer, int *buflen, struct vomsdata *vd, int *error)
int VOMS_SetVerificationTime(time_t verificationtime, struct vomsdata *vd, int *error)
struct voms * VOMS_Copy(struct voms *v, int *error)
AC * VOMS_GetAC(struct voms *v)
int VOMS_ContactRaw(char *hostname, int port, char *servsubject, char *command, void **data, int *datalen, int *version, struct vomsdata *vd, int *error)
int VOMS_GetAttributeSourceHandle(struct voms *v, int num, struct vomsdata *vd, int *error)
int VOMS_GetAttributeSourcesNumber(struct voms *v, struct vomsdata *vd, int *error)
void * gss_ctx_id_t
Definition voms_apic.h:36
int VOMS_Contact(char *hostname, int port, char *servsubject, char *command, struct vomsdata *vd, int *error)
int VOMS_RetrieveFromProxy(int how, struct vomsdata *vd, int *error)
int VOMS_Retrieve(X509 *cert, STACK_OF(X509) *chain, int how, struct vomsdata *vd, int *error)
void VOMS_Destroy(struct vomsdata *vd)
char * VOMS_ErrorMessage(struct vomsdata *vd, int error, char *buffer, int len)
int VOMS_AddTarget(struct vomsdata *vd, char *target, int *error)
void VOMS_FreeTargetsList(char **)
int VOMS_Ordering(char *order, struct vomsdata *vd, int *error)
void VOMS_Delete(struct voms *v)
int VOMS_SetLifetime(int length, struct vomsdata *vd, int *error)
struct vomsdata * VOMS_Init(char *voms, char *cert)
void VOMS_FreeTargets(struct vomsdata *vd, int *error)
struct contactdata ** VOMS_FindByVO(struct vomsdata *vd, char *vo, char *system, char *user, int *error)
struct voms * VOMS_DefaultData(struct vomsdata *vd, int *error)
int VOMS_SetVerificationType(int type, struct vomsdata *vd, int *error)