client_functions.h

Go to the documentation of this file.

/*
 * Copyright 2003 Michael A. Marsh, Cornell University. All rights reserved.
 * This software is released under the modified BSD license.
 * See the file LICENSE in the top-level directory for details.
 */
/*
 * $Id: client_functions.h,v 1.6 2005/01/21 19:44:16 mmarsh Exp $
 *
 * $Log: client_functions.h,v $
 * Revision 1.6  2005/01/21 19:44:16  mmarsh
 * Updated for compatibility with Doxygen 1.4.1
 *
 * Revision 1.5  2004/05/19 15:56:49  mmarsh
 * *** empty log message ***
 *
 * Revision 1.4  2003/11/13 15:01:52  mmarsh
 * There were C++-style comments in the parts of the file that are supposed
 * to be C-usable.  Whether it works or not, it's non-ANSI and has been fixed.
 *
 * Revision 1.3  2003/11/06 17:01:03  mmarsh
 * Added the implementations for the C wrappers.  This required some changes
 * in the prototypes and structures, as well.
 *
 * The namespace CODEX_Client::Interface was incorrectly defined.  This has
 * now been fixed.
 *
 * Revision 1.2  2003/11/04 22:31:48  mmarsh
 * *** empty log message ***
 *
 */

#ifndef __CODEX_CLIENT_CLIENT_FUNCTIONS_H__
#define __CODEX_CLIENT_CLIENT_FUNCTIONS_H__

#include <openssl/bn.h>
#include <openssl/rsa.h>

/* We don't want to confuse regular C code. */
#ifdef __cplusplus

#include "Client.h"


namespace CODEX_Client
{
   namespace Interface
   {
      class Interface : public Client
      {
         public :
            static Interface* instance();
            static void destroy();
         private :
            Interface();
            virtual ~Interface() {}
            static Interface* m_instance;
      };

extern "C"
{
#endif /* __cplusplus */

   typedef struct
   {
         unsigned char* data; 
         long           length; 
   } codex_policy_t;

   typedef struct
   {
         unsigned char* data; 
         long           length; 
   } codex_credentials_t;

   typedef struct
   {
         /* Marshalled data */
         unsigned char * data; 
         long            length; 
         /* BoundNameMsg::m_name */
         unsigned char * name; 
         long            namelen; 
         /* BoundNameMsg::m_request */
         X509          * owner; 
         codex_policy_t* read_policy; 
         codex_policy_t* write_policy; 
         /* SignedBoundNameMsg::m_signature */
         BIGNUM        * signature; 
   } codex_binding_t;


   void codex_zero_policy( codex_policy_t* policy );

   void codex_zero_credentials( codex_credentials_t* credentials );

   void codex_zero_binding( codex_binding_t* binding );


   codex_policy_t* codex_new_policy();

   codex_credentials_t* codex_new_credentials();

   codex_binding_t* codex_new_binding();



   void codex_clear_policy( codex_policy_t* policy );

   void codex_clear_credentials( codex_credentials_t* credentials );

   void codex_clear_binding( codex_binding_t* binding );


   void codex_free_policy( codex_policy_t* policy );

   void codex_free_credentials( codex_credentials_t* credentials );

   void codex_free_binding( codex_binding_t* binding );


   int codex_parse_binding( codex_binding_t* binding );


   int codex_set_server( const char* name, int port );

   int codex_set_service_key( const X509* cert );

   int codex_set_key_pair( const X509* cert, const RSA* key );

   int codex_create_policy( const RSA* policy_pub_key,
                            const RSA* owner_priv_key,
                            codex_policy_t* policy );

   int codex_issue_credentials( const RSA* client_pub_key,
                                const RSA* policy_priv_key,
                                codex_credentials_t* credentials );

   int codex_create_key( const unsigned char* name,
                         int length,
                         const X509* owner_cert,
                         const codex_policy_t* read_policy,
                         const codex_policy_t* write_policy,
                         codex_binding_t* binding );

   int codex_write_key( const unsigned char* name,
                        int length,
                        const BIGNUM* key_value,
                        const codex_credentials_t* credentials,
                        const RSA* cred_private_key,
                        const codex_binding_t* binding );

   int codex_read_key( const unsigned char* name,
                       int length,
                       const codex_credentials_t* credentials,
                       const RSA* cred_private_key,
                       BIGNUM** returned_key_value );

   int codex_to_file( const char* fname );

   int codex_from_file( const char* fname );

   void codex_clean_up();

#ifdef __cplusplus
} /* extern "C" */
   } /* namespace Interface */
} /* namespace CODEX_Client */
#endif

#endif /* __CODEX_CLIENT_CLIENT_FUNCTIONS_H__ */

---