libswoccommon.h

Go to the documentation of this file.

 
/* **********************************************************************
 *                                  *
 * Changelog                                *
 *                                  *
 * Date     Author  Version Description             *
 *                                  *
 * 24/10/2017   MG  1.0.1   This ChangeLog introduced.      *
 * 29/10/2017   MG  1.0.2   Move port / socket mapping struct to    *
 *              swocserverd.h.              *
 * 10/11/2017   MG  1.0.3   Add Doxygen comments.           *
 *              Add SPDX license tag.           *
 * 07/03/2018   MG  1.0.4   Remove redundant global variable portno *
 * 01/05/2018   MG  1.0.5   Add support for blocked clients list.   *
 * 10/05/2018   MG  1.0.6   Add support for server list of blocked  *
 *              clients.                *
 *              Improve function name consistency,  *
 *              unlock -> release.          *
 *              Add support for server blocking.    *
 * 15/08/2018   MG  1.0.7   Change parameter name to prevent shadow.*
 * 18/05/2019   MG  1.0.8   Merge sub-projects into one.        *
 * 15/03/2020   MG  1.0.9   Add swocid request type.        *
 * 10/10/2021   MG  1.1.0   Make file internal, tightening API. *
 * 11/10/2021   MG  1.1.1   Move to internal directory.     *
 * 08/12/2021   MG  1.1.2   Tighten SPDX tag.           *
 *                                  *
 ************************************************************************
 */
 
#ifndef LIBSWOCCOMMON_H
#define LIBSWOCCOMMON_H
 
#include <netdb.h>
#include <sys/types.h>
 
#include <mgemessage.h>
#include <portability.h>
 
BEGIN_C_DECLS
 
extern int pollint;
extern int ssh;
extern char server[];
extern int srvportno;
extern int sshportno;
extern char sshuser[];
 
#define SOCK_BUF_SIZE 256
 
#define SOCK_Q_LEN 10
 
#define SSH_CHAN_POLL_TIMEOUT 10000
 
enum msg_source { swocclient, swocserver, swocserverd, src_err };
 
enum msg_request {
    swocallow,
    swocblock,
    swocblocklist,
    swocblockstatus,
    swocdisallow,
    swocend,
    swocid,
    swoclock,
    swocrelease,
    swocreload,
    swocreset,
    swocstatus,
    swocunblock,
    req_err
};
 
enum msg_arguments { args_ok, args_err };
 
enum comms_mode { recv_mode, send_mode };
 
int swcom_validate_config(void);
 
int prep_recv_sock(int *sockfd, int *portno);
 
int init_conn(int *sockfd, int *portno, char *srv);
 
int est_connect(int *sfd, char *serv, int *portno, struct addrinfo *hints,
        enum comms_mode *mode);
 
int listen_sock(const int *sfd);
 
int close_sock(const int *sockfd);
 
void parse_msg(struct mgemessage *msg, enum msg_arguments *msg_args,
           enum msg_source *msg_src, enum msg_request *msg_req);
 
int send_outgoing_msg(char *outgoing_msg, size_t outgoing_msg_length,
              int *newsockfd);
 
int exch_msg(char *outgoing_msg, size_t om_length, struct mgemessage *msg);
 
int open_ssh_tunnel(void);
 
int close_ssh_tunnel(void);
 
char *libswoccommon_get_pkg_version(void);
 
char *libswoccommon_get_src_version(void);
 
void libswoccommon_print_pkg_version(void);
 
void libswoccommon_print_src_version(void);
 
END_C_DECLS
 
#endif /* ndef LIBSWOCCOMMON_H */