keystore_client.h File Reference

Secure Storage Keystore client API Library header file This acts as Client in the KEY/IV exchange with Secure Storage Keystore. More...

#include <sys/socket.h>
#include <globus_gss_assist.h>

Go to the source code of this file.

Defines
#define	KEYSTORE_HOST   "SS_GRID_KEYSTORE_HOST"
#define	KEYSTORE_DN   "SS_GRID_KEYSTORE_DN"
#define	SEND   0
#define	GET   1
#define	DEL   2
#define	SSKEYSTORE_EPARAM   10001
#define	SSKEYSTORE_ESAVE   10002
#define	SSKEYSTORE_EPERM   10003
#define	SSKEYSTORE_ERROR   10004
#define	SSKEYSTORE_EREAD   10005
#define	SSKEYSTORE_EDELETE   10006
#define	SSKEYSTORE_ENOENT   10007
#define	SSKEYSTORE_EEXIST   10008
#define	SS_EINVALLFN   10009
#define	SS_EINVALVO   10010
#define	SS_EINVALGUID   10011
#define	SS_EINVALSE   10012
#define	SS_EINVALSOURCE   10013
#define	SS_EINVALDEST   10014
#define	SS_EINVAL   10015
#define	SS_EEXIST   10016
#define	SS_ENOENT   10017
#define	SS_ENOREPLICA   10018
#define	SS_EACCES   10019
#define	SS_ESPIPE   10020
#define	SS_EOFFSET   10021
#define	SS_EWHENCE   10022
#define	SS_ESOURCENAMETOOLONG   10023
#define	SS_EDESTNAMETOOLONG   10024
#define	SS_ENAMETOOLONG   10025
#define	SS_ENOGRIDSSKEYSTOREENV   10026
#define	SS_ENOGRIDSSKEYSTOREDNENV   10027
#define	SS_ENOLOCALSSKEYSTOREENV   10028
#define	SS_ENOLOCALSSKEYSTOREDNENV   10029
#define	SS_EKEYSTOREAUTH   10030
#define	SS_EKEYSTORECONNFAILED   10031
#define	SS_EKEYSTORESEND   10032
#define	SS_EKEYSTORERCV   10033
#define	SS_EKEYSTORECLOSE   10034
#define	SS_EENCINIT   10035
#define	SSKEYSTORE_HOSTNOTFOUND   10036
#define	SSKEYSTORE_NODATAORADDR   10037
#define	SSKEYSTORE_NORECOVERY   10038
#define	SSKEYSTORE_TRY_AGAIN   10039
#define	SSKEYSTORE_NOCREDFOUND   10040
#define	SSKEYSTORE_NOSECURECONTEXT   10041
#define	SSKEYSTORE_FAILEDINQUIRECONTEXT   10042
#define	SSKEYSTORE_FAILEDDELETECONTEXT   10043
#define	SSKEYSTORE_CONTEXTEXPIRED   10044
#define	SSKEYSTORE_BADQOP   10045
#define	SSKEYSTORE_FAILEDWRAPMSG   10046
#define	SSKEYSTORE_INVALIDTOKEN   10047
#define	SSKEYSTORE_TOKENEOF   10048
#define	SSKEYSTORE_TOKENTOOLARGE   10049
#define	SSKEYSTORE_DEFECTIVETOKEN   10050
#define	SSKEYSTORE_BADSIG   10051
#define	SSKEYSTORE_DUPLICATETOKEN   10052
#define	SSKEYSTORE_UNSEQTOKEN   10053
#define	SSKEYSTORE_GAPTOKEN   10054
#define	SSKEYSTORE_FAILEDUNWRAPMSG   10055
Typedefs
typedef int	param_len
Functions
int	ss_send_key (const char *lfn, const unsigned char *key, const unsigned char *iv)
	Send Key Function.
int	ss_get_key (const char *lfn, unsigned char *key, unsigned char *iv)
	Get Key Function.
int	ss_delete_key (const char *lfn)
	Key Delete Function.

---

Detailed Description

Secure Storage Keystore client API Library header file This acts as Client in the KEY/IV exchange with Secure Storage Keystore.

Author:

Giordano Scuderi and Nicola Dominante

Date:

2007

Definition in file keystore_client.h.

---

Define Documentation

#define DEL   2

Definition at line 138 of file keystore_client.h. Referenced by ss_delete_key().

#define GET   1

Definition at line 137 of file keystore_client.h. Referenced by ss_get_key().

#define KEYSTORE_DN   "SS_GRID_KEYSTORE_DN"

Definition at line 135 of file keystore_client.h.

#define KEYSTORE_HOST   "SS_GRID_KEYSTORE_HOST"

Definition at line 134 of file keystore_client.h.

#define SEND   0

Definition at line 136 of file keystore_client.h. Referenced by ss_send_key().

#define SS_EACCES   10019

Definition at line 158 of file keystore_client.h. Referenced by lcg_scp().

#define SS_EDESTNAMETOOLONG   10024

Definition at line 163 of file keystore_client.h. Referenced by lcg_scr().

#define SS_EENCINIT   10035

Definition at line 174 of file keystore_client.h. Referenced by lcg_scp(), lcg_scr(), and securestorage_open_extended().

#define SS_EEXIST   10016

Definition at line 155 of file keystore_client.h. Referenced by lcg_scp(), lcg_scr(), and securestorage_open_extended().

#define SS_EINVAL   10015

Definition at line 154 of file keystore_client.h. Referenced by securestorage_closedir(), securestorage_mkdir(), securestorage_opendir(), and securestorage_readdir().

#define SS_EINVALDEST   10014

Definition at line 153 of file keystore_client.h. Referenced by lcg_scp().

#define SS_EINVALGUID   10011

Definition at line 150 of file keystore_client.h. Referenced by lcg_scr(), and securestorage_open_extended().

#define SS_EINVALLFN   10009

Definition at line 148 of file keystore_client.h. Referenced by lcg_scp(), lcg_scr(), lcg_sdel(), securestorage_del_extended(), securestorage_mkdir(), securestorage_open(), securestorage_open_extended(), securestorage_open_se(), securestorage_opendir(), securestorage_rmdir(), and securestorage_statg().

#define SS_EINVALSE   10012

Definition at line 151 of file keystore_client.h. Referenced by lcg_scr(), lcg_sdel(), securestorage_del(), securestorage_del_extended(), securestorage_open(), securestorage_open_extended(), and securestorage_open_se().

#define SS_EINVALSOURCE   10013

Definition at line 152 of file keystore_client.h.

#define SS_EINVALVO   10010

Definition at line 149 of file keystore_client.h. Referenced by lcg_scp(), lcg_scr(), lcg_sdel(), securestorage_del(), securestorage_del_extended(), securestorage_open(), securestorage_open_extended(), and securestorage_open_se().

#define SS_EKEYSTOREAUTH   10030

Definition at line 169 of file keystore_client.h.

#define SS_EKEYSTORECLOSE   10034

Definition at line 173 of file keystore_client.h.

#define SS_EKEYSTORECONNFAILED   10031

Definition at line 170 of file keystore_client.h.

#define SS_EKEYSTORERCV   10033

Definition at line 172 of file keystore_client.h.

#define SS_EKEYSTORESEND   10032

Definition at line 171 of file keystore_client.h.

#define SS_ENAMETOOLONG   10025

Definition at line 164 of file keystore_client.h. Referenced by securestorage_del_extended().

#define SS_ENOENT   10017

Definition at line 156 of file keystore_client.h. Referenced by lcg_sdel(), securestorage_del_extended(), and ss_get_surl().

#define SS_ENOGRIDSSKEYSTOREDNENV   10027

Definition at line 166 of file keystore_client.h.

#define SS_ENOGRIDSSKEYSTOREENV   10026

Definition at line 165 of file keystore_client.h.

#define SS_ENOLOCALSSKEYSTOREDNENV   10029

Definition at line 168 of file keystore_client.h.

#define SS_ENOLOCALSSKEYSTOREENV   10028

Definition at line 167 of file keystore_client.h.

#define SS_ENOREPLICA   10018

Definition at line 157 of file keystore_client.h. Referenced by securestorage_del_extended().

#define SS_EOFFSET   10021

Definition at line 160 of file keystore_client.h. Referenced by securestorage_lseek().

#define SS_ESOURCENAMETOOLONG   10023

Definition at line 162 of file keystore_client.h. Referenced by lcg_scp(), and lcg_sdel().

#define SS_ESPIPE   10020

Definition at line 159 of file keystore_client.h. Referenced by securestorage_lseek().

#define SS_EWHENCE   10022

Definition at line 161 of file keystore_client.h. Referenced by securestorage_lseek().

#define SSKEYSTORE_BADQOP   10045

Definition at line 184 of file keystore_client.h.

#define SSKEYSTORE_BADSIG   10051

Definition at line 190 of file keystore_client.h.

#define SSKEYSTORE_CONTEXTEXPIRED   10044

Definition at line 183 of file keystore_client.h.

#define SSKEYSTORE_DEFECTIVETOKEN   10050

Definition at line 189 of file keystore_client.h.

#define SSKEYSTORE_DUPLICATETOKEN   10052

Definition at line 191 of file keystore_client.h.

#define SSKEYSTORE_EDELETE   10006

Definition at line 145 of file keystore_client.h.

#define SSKEYSTORE_EEXIST   10008

Definition at line 147 of file keystore_client.h.

#define SSKEYSTORE_ENOENT   10007

Definition at line 146 of file keystore_client.h.

#define SSKEYSTORE_EPARAM   10001

Definition at line 140 of file keystore_client.h.

#define SSKEYSTORE_EPERM   10003

Definition at line 142 of file keystore_client.h.

#define SSKEYSTORE_EREAD   10005

Definition at line 144 of file keystore_client.h.

#define SSKEYSTORE_ERROR   10004

Definition at line 143 of file keystore_client.h.

#define SSKEYSTORE_ESAVE   10002

Definition at line 141 of file keystore_client.h.

#define SSKEYSTORE_FAILEDDELETECONTEXT   10043

Definition at line 182 of file keystore_client.h.

#define SSKEYSTORE_FAILEDINQUIRECONTEXT   10042

Definition at line 181 of file keystore_client.h.

#define SSKEYSTORE_FAILEDUNWRAPMSG   10055

Definition at line 194 of file keystore_client.h.

#define SSKEYSTORE_FAILEDWRAPMSG   10046

Definition at line 185 of file keystore_client.h.

#define SSKEYSTORE_GAPTOKEN   10054

Definition at line 193 of file keystore_client.h.

#define SSKEYSTORE_HOSTNOTFOUND   10036

Definition at line 175 of file keystore_client.h.

#define SSKEYSTORE_INVALIDTOKEN   10047

Definition at line 186 of file keystore_client.h.

#define SSKEYSTORE_NOCREDFOUND   10040

Definition at line 179 of file keystore_client.h.

#define SSKEYSTORE_NODATAORADDR   10037

Definition at line 176 of file keystore_client.h.

#define SSKEYSTORE_NORECOVERY   10038

Definition at line 177 of file keystore_client.h.

#define SSKEYSTORE_NOSECURECONTEXT   10041

Definition at line 180 of file keystore_client.h.

#define SSKEYSTORE_TOKENEOF   10048

Definition at line 187 of file keystore_client.h.

#define SSKEYSTORE_TOKENTOOLARGE   10049

Definition at line 188 of file keystore_client.h.

#define SSKEYSTORE_TRY_AGAIN   10039

Definition at line 178 of file keystore_client.h.

#define SSKEYSTORE_UNSEQTOKEN   10053

Definition at line 192 of file keystore_client.h.

---

Typedef Documentation

typedef int param_len

Include the secure socket globus definition. Definition at line 83 of file keystore_client.h. Referenced by ss_delete_key(), ss_get_key(), and ss_send_key().

---

Function Documentation

int ss_delete_key (  const char *  lfn  )

Key Delete Function. This function delete key from Keystore. See also: ss_send_key() ss_get_key() Parameters: lfn  is the Logical File Name of the GRID file Returns: 0 if success or !=0 if fail, in the latter case securestorage_errno is set appropriately. Definition at line 966 of file keystore_client.c. References DEL, errno, and param_len. Referenced by lcg_scr(), lcg_sdel(), and securestorage_del_extended().

int ss_get_key (  const char *  lfn, unsigned char *  key, unsigned char *  iv )

Get Key Function. This function get key from Keystore. See also: ss_delete_key() ss_send_key() Parameters: lfn  is the Logical File Name of the GRID file key  is the returned Key in hex format iv  is the returned Ivec in hex format Returns: 0 if success or !=0 if fail, in the latter case securestorage_errno is set appropriately. Definition at line 850 of file keystore_client.c. References errno, GET, and param_len. Referenced by lcg_scp(), and securestorage_open_extended().

int ss_send_key (  const char *  lfn, const unsigned char *  key, const unsigned char *  iv )

Send Key Function. This function save key to Keystore. See also: ss_delete_key() ss_get_key() Parameters: lfn  is the Logical File Name of the GRID file key  is the Key in hex format iv  is the Ivec in hex format Returns: 0 if success or !=0 if fail, in the latter case securestorage_errno is set appropriately. Definition at line 763 of file keystore_client.c. References errno, param_len, and SEND. Referenced by lcg_scr(), and securestorage_open_extended().

---