securestorage.h

Go to the documentation of this file.

/* ====================================================================
 *      File:                   securestorage.h
 *
 *      Function:               Secure Storage header file
 *
 *      Author(s):              Giordano Scuderi and Nicola Dominante
 *
 *      Copyright:              Copyright (c) 2007 <Giordano Scuderi - gscuderi@unicosrl.it>
 *                                      All Rights Reserved.
 *
 *      Notes:                  Redistributions of any form whatsoever must retain the following
 *                              acknowledgment:
 *                              "This product includes software developed by Giordano Scuderi
 *                              for Unico SRL"
 *
 * ====================================================================
 * Copyright (c) Giordano Scuderi, Unico SRL.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer. 
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. All advertising materials mentioning features or use of this
 *    software must display the following acknowledgment:
 *    "This product includes software developed by Giordano Scuderi
 *    for Unico SRL"
 *
 * 4. The names "Secure Storage" must not be used to
 *    endorse or promote products derived from this software without
 *    prior written permission. For written permission, please contact
 *    gscuderi@unicosrl.it.
 *
 * 5. Products derived from this software may not be called "Secure Storage"
 *    nor may "Secure Storage" appear in their names without prior written
 *    permission of Giordano Scuderi (Unico SRL).
 *
 * 6. Redistributions of any form whatsoever must retain the following
 *    acknowledgment:
 *    "This product includes software developed by Giordano Scuderi
 *    for Unico SRL"
 *
 * THIS SOFTWARE IS PROVIDED BY UNICO SRL ``AS IS'' AND ANY
 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL UNICO SRL OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 * ====================================================================
 *
 * "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
 * 
 */
 
// \def Max lenght of LFN Path.
#define LCG_MAXPATHLEN 1023
// \def Max lenght of local Path.
#define MAXPATHLENGTH 255
// \def Default Virtual Organization Environment Variable.
#define VO "LCG_GFAL_VO"

typedef unsigned long long u_signed64;
// \def Maximum length for a pool name.
#define SS_MAXPOOLNAMELEN 15
// \def Maximum length for a hostname.
#define SS_MAXHOSTNAMELEN 63
// \def Maximum length for a replica.
#define SS_MAXSFNLEN    1103
// \def Maximum length for a GUID.
#define SS_MAXGUIDLEN     36

// \struct LFC Directory structure.
typedef struct {
        int             dd_fd;          /* socket for communication with server */
        u_signed64      fileid;
        int             bod;            /* beginning of directory */
        int             eod;            /* end of directory */
        int             dd_loc;         /* offset in buffer */
        int             dd_size;        /* amount of data in buffer */
        char            *dd_buf;        /* directory buffer */
        int             nbreplicas;
        char            *replicas;
} ss_DIR;

// \struct LFC filestat structure.
struct ss_filestatg {
        u_signed64      fileid;
        char            guid[SS_MAXGUIDLEN+1];
        mode_t          filemode;
        int             nlink;          /* number of files in a directory */
        uid_t           uid;
        gid_t           gid;
        u_signed64      filesize;
        time_t          atime;          /* last access to file */
        time_t          mtime;          /* last file modification */
        time_t          ctime;          /* last metadata modification */
        short           fileclass;      /* 1 --> experiment, 2 --> user */
        char            status;         /* ' ' --> online, 'm' --> migrated */
        char            csumtype[3];
        char            csumvalue[33];
};

struct lfc_filereplica {
        u_signed64      fileid;
        u_signed64      nbaccesses;
        time_t          atime;          /* last access to replica */
        time_t          ptime;          /* replica pin time */
        char            status;
        char            f_type;
        char            poolname[SS_MAXPOOLNAMELEN+1]; 
        char            host[SS_MAXHOSTNAMELEN+1];
        char            fs[80];
        char            sfn[SS_MAXSFNLEN+1];
};

#ifdef __cplusplus
extern "C" {
#endif

int lcg_scr(char *src_file,char *dest_file,char *guid,char *lfn,char *vo,
                char *conf_file,int insecure,int verbose,char *actual_gid);

int lcg_scp(char *src_file,char *dest_file,char *vo,char *conf_file,
                                int insecure,int verbose);

int lcg_sdel(char *src_file,int aflag,char *se,char *vo,char *conf_file,
                                int insecure,int verbose,int timeout);


/******************************************************************************
 * 
 *  SecureStorage API - encrypt/decrypt block of data
 * 
 *
 *
 ******************************************************************************/
 
int securestorage_open_extended(char *lfn, int flags, mode_t mode, 
                                                                        char *vo, char *guid, char *se);

int securestorage_open_se (char *lfn, int flags, mode_t mode, char *se) ;


int securestorage_open( char *lfn, int flags, mode_t mode );


int securestorage_close (int fd);


int securestorage_write (int fd, void *buffer, size_t size );


int securestorage_read ( int fd, void *buffer, size_t size );


off_t securestorage_lseek (int fd, off_t offset, int whence);


int securestorage_del_extended (char *lfn,int aflag,char *se,char *vo,
                                                char *conf_file,int insecure,int verbose,int timeout);


int securestorage_del ( char *lfn, int aflag, char *se );


ss_DIR *securestorage_opendir (const char *name);


struct dirent *securestorage_readdir (ss_DIR *dp);


int securestorage_closedir (ss_DIR *dp);


int securestorage_mkdir (const char *path, mode_t mode);


int securestorage_rmdir (const char *path);


int securestorage_statg (const char *path, const char *guid, 
                                                                struct ss_filestatg *statbuf);


const char *securestorage_error(int errnum);


#ifdef __cplusplus
} /* closing brace for extern "C" */
#endif

---