src/vsl_api.h

Go to the documentation of this file.

/*
 * Copyright 2006, Internet2
 * Legal conditions are in file LICENSE
 * (MD5 = c434f2e53b8089d8b4d0172c7ce07360).
 */

/**
 *
 * @file   vsl_api.h
 * @author Nikolaus Rath
 * @brief  Security Layer API declarations
 *
 */

#ifndef VSL_API_H
#define VSL_API_H

#include "vfer_api.h"

//! VSL main key length
#define VSL_KEYLEN 32

//! VSL encryption key length
#define VSL_ENC_KEYLEN 16

//! VSL MAC length
#define VSL_MACLEN 16

//! VSL MAC key length
#define VSL_AUTH_KEYLEN 32

//! VSL authentication types
typedef enum {
    VSL_AUTH_SSH,
    VSL_AUTH_DH,
} vsl_auth_t;

//! VSL errorcodes
typedef enum {
    VSL_BADPROT = -255,         //!< protocol error
    VSL_MAXMSG,                 //!< maximum message count reached
    VSL_ERRNO,                  //!< system call failed
    VSL_SSHF,                   //!< ssh process failed
    VSL_TOOBIG,                 //!< message too big

    //! temporary server error (ssh starting mode)
    VSL_TEMP=20,
    //! permanent server error (ssh starting mode)
    VSL_PERM,
} vsl_errcode_t;

//! VSL socket structure
typedef struct {
    vfer_fd vfd;               //!< underlying vfer socket identifier
     vsl_auth_t auth;           //!< type of authentication performed
     unsigned char enc_send_key[VSL_ENC_KEYLEN]; //!< encrytion key for sending
     unsigned char enc_recv_key[VSL_ENC_KEYLEN]; //!< encrytion key for receiving
     unsigned char auth_send_key[VSL_AUTH_KEYLEN]; //!< authentication key for sending
     unsigned char auth_recv_key[VSL_AUTH_KEYLEN]; //!< authentication key for receiving
     uint64_t sent_nr;          //!< nr of last sent packet
     uint64_t recv_nr;          //!< nr of last received packet
     int status;                //!< connection status
     int selectmark;            //!< select marks for this socket
     int selectres; //!< results of the last select call for this socket
     pid_t ssh_pid;         //!< pid of ssh process (client mode only)
    int ssh_pid_stat;        //!< exit status of ssh process if received by vsl_select().
     int ssh_stdin_fd; //!< fd of ssh process stdin (client mode only)
     int ssh_stdout_fd; //!< fd of ssh process stdout (client mode only)
    int ssh_stderr_fd; //!< fd of ssh process stderr (client mode only)
    bool test_mode; //!< whether the socket is in special testing mode
} vsl_sock;


//! VSL socket select markers
typedef enum {
    VSL_READABLE=1,             //!< ready to read
    VSL_WRITABLE=2,             //!< ready to write
    VSL_EXCEPTION=4,            //!< exception occured
    VSL_AUTHABLE=8,             //!< ready fror next authentication step
} vsl_sock_mark_t;


/*
 * function prototypes
 */

// Global init+destruct
int vsl_init            (void);
int vsl_uninit          (void);

// Socket init+destruct
int vsl_socket          (vsl_sock* socket, const vfer_fd vfd);
void vsl_close          (vsl_sock* socket);

// Handshake
int vsl_connect_ssh     (vsl_sock* sock, const char* host, const char* user,
                         const char* cmd, int argc, const char* const *argv, char* errmsg);
int vsl_accept_ssh      (vsl_sock* sock);

// IO Multiplexing
int vsl_selectmark      (vsl_sock* socket, int mark);
int vsl_selecttest      (vsl_sock* socket);
int vsl_select          (int len, vsl_sock **socks, struct timeval *timeout);
int vsl_selectpoll(int len, vsl_sock** socks, struct timeval *stimeout, int usec);


// Information
char* vsl_errortext     (int err);
vfer_fd vsl_vferfd      (vsl_sock* socket);
ssize_t vsl_max_frame_size  (vsl_sock* socket);

// Sending and receiving
ssize_t vsl_send            (vsl_sock* socket, const void * buf, size_t len);
ssize_t vsl_recv            (vsl_sock* socket, void *buf, size_t len);
ssize_t vsl_sendfile        (vsl_sock* socket, int fd, off_t offset, size_t size);
ssize_t vsl_recvfile        (vsl_sock* socket, int fd, off_t offset, size_t size);

// Testing and debugging
extern FILE* debug;
void vsl_debug          (FILE* fp, const char* vfer);
void vsl_test_mode(vsl_sock* sock);


#endif

/*
 * Local Variables:
 * compile-command: "cd ..; make tests file_xfer"
 * compilation-search-path: ("..")
 * End:
 */

---