generic_plugin.h

Go to the documentation of this file.

/*
   Copyright 2013 Broadcom Corporation

        This program is free software; you can redistribute it and/or
        modify it under the terms of the GNU Lesser General Public
        License version 2.1  as published by the Free Software Foundation.

        This library is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
        Lesser General Public License for more details.

        You should have received a copy of the GNU Lesser General Public
        License along with this library; if not, write to the Free Software
        Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/
#ifndef GENPLUGIN_H_
#define GENPLUGIN_H_
#include <iostream>
#include <string>
using namespace std;
#include <openssl/ssl.h>
#include <openssl/err.h>
#ifdef CRYPTOPP
#define CRYPTOPP_ENABLE_NAMESPACE_WEAK 1
#include "cryptlib.h"
#include "smartptr.h"
#include "algparam.h"
#include "hex.h"
#include "files.h"
#include "hex.h"
#include "base32.h"
#include "base64.h"
#include "modes.h"
#include "cbcmac.h"
#include "dmac.h"
#include "idea.h"
#include "des.h"
#include "rc2.h"
#include "arc4.h"
#include "rc5.h"
#include "blowfish.h"
#include "3way.h"
#include "safer.h"
#include "gost.h"
#include "shark.h"
#include "cast.h"
#include "square.h"
#include "seal.h"
#include "rc6.h"
#include "mars.h"
#include "rijndael.h"
#include "twofish.h"
#include "serpent.h"
#include "skipjack.h"
#include "shacal2.h"
#include "camellia.h"
#include "osrng.h"
#include "zdeflate.h"
#include "cpu.h"
#include "crc.h"
using namespace CryptoPP;
#endif
using namespace std;
#ifndef WINDOWS

#define SOCKET int
#define sprintf_s snprintf
#define _stat stat
#define SOCKET_ERROR -1
#define INVALID_SOCKET -1
#define SD_SEND 2
#endif
#define CONTINUE_SESSION 0xFF
#define TERMINATE_SESSION 0x00
#define PLUGIN_SIGNATURE 0xDEDDAECF
#define HEX 0
#define BIN 1

#ifdef WINDOWS
#pragma warning(disable:4251)
#define GEN_PLUGIN_MUTEX HANDLE
#define INIT_MUTEX CreateMutex( NULL, FALSE, NULL );
#else
#define GEN_PLUGIN_MUTEX pthread_mutex_t
#define INIT_MUTEX PTHREAD_MUTEX_INITIALIZER;
#endif
#ifdef WINDOWS
class LIBTYPE generic_plugin
{
friend LIBTYPE ostream& operator<<(ostream& output, generic_plugin& p);
#else
class generic_plugin
{
friend ostream& operator<<(ostream& output, generic_plugin& p);
#endif
protected:
    SOCKET server_socket;
    SOCKET client_socket;
    int port,tls_enabled,thread_id;
    char *local_ip_address;
    string plugin_type;
    string plugin_name;
    string plugin_number;
    string plugin_lib_path;
    unsigned int networking,verbose_level;
    bool validate_plugin;
    vector<string> v_plugin_aliases;
    int log(unsigned int,char *);
    int log(unsigned int,string );

public:
    unsigned long pinstance; 
    string plugin_conf_file;
    string generic_plugin_version();
    generic_plugin(void);
    generic_plugin(char *,int);
    generic_plugin(char *,char *,int);
    GEN_PLUGIN_MUTEX create_mutex(void);
    int lock_mutex(GEN_PLUGIN_MUTEX *);
    int rel_mutex(GEN_PLUGIN_MUTEX *);
    bool get_validate_plugin(void);
    virtual unsigned short get_session(void) {return(0);};
    virtual int plugin_init(int thread_no) {return(0);};
    virtual int get_plugin_params(string line);
    virtual int process_request(void *buffer, void *out_buff,unsigned int &size) {return(0);};
    virtual int server_init(void){return(1);};
   virtual int server_shutdown(void){return(1);};
   virtual string get_plugin_version(void) {return("UNKNOWN");};
    virtual int shutdown_plugin(void) {return(1);};
virtual string bootstrap_name(void);
        virtual bool bootstrap_init(string);
        virtual bool bootstrap_terminate(string){return(true);};
    SOCKET get_socket();
    int get_port();
    int get_thread_id();
    int get_tls_flag();
    string get_plugin();
    string get_plugin_name();
    string get_plugin_number();
    string get_plugin_path();
    int set_plugin(string);
    int set_plugin_name(string);
    int set_plugin_number(string);
    int set_port(int);
    int set_tls_flag(int);
    int set_thread_id(int);
    int set_socket(SOCKET);
    int set_plugin_path(string);
    int add_plugin_alias(string);
    int clear_aliases();
    int aliases_count();
    string pop_alias();
    bool find_plugin_alias(string);
    SOCKET initialize_socket(string port);
    int set_client_socket(SOCKET);
    int set_conf_file(string);
    string get_conf_file();
    SOCKET get_client_socket(void);
    generic_plugin &operator=(const generic_plugin &);
    bool operator<(generic_plugin a)
    {
        return this->get_port() < a.get_port();
    }
    bool operator==(generic_plugin a)
    {
        return this->get_port() == a.get_port();
    }
    virtual ~generic_plugin() {};
};
typedef generic_plugin GENERIC_PLUGIN;

#endif