msgmod_plugin.h

/*
 * Copyright (c) 2008, 2009, 2013, 2015 by Farsight Security, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef NMSG_MSGMOD_PLUGIN_H
#define NMSG_MSGMOD_PLUGIN_H
 
#include <nmsg.h>
 
#include <protobuf-c/protobuf-c.h>
#include <nmsg/nmsg.pb-c.h>
 
struct nmsg_msgmod_field;
 
#define NMSG_MSGMOD_VERSION     9
 
typedef nmsg_res (*nmsg_msgmod_init_fp)(void **clos);
 
typedef nmsg_res (*nmsg_msgmod_fini_fp)(void **clos);
 
typedef nmsg_res (*nmsg_msgmod_payload_to_pres_fp)(Nmsg__NmsgPayload *np,
                                                   char **pres,
                                                   const char *endline);
 
typedef nmsg_res (*nmsg_msgmod_ipdg_to_payload_fp)(void *clos,
                                                   const struct nmsg_ipdg *dg,
                                                   uint8_t **pbuf, size_t *sz);
 
typedef nmsg_res (*nmsg_msgmod_pkt_to_payload_fp)(void *clos,
                                                  nmsg_pcap_t pcap,
                                                  nmsg_message_t *m);
 
typedef nmsg_res (*nmsg_msgmod_pcap_init_fp)(void *clos, nmsg_pcap_t pcap);
 
typedef nmsg_res (*nmsg_msgmod_msg_load_fp)(nmsg_message_t m, void **msg_clos);
 
typedef nmsg_res (*nmsg_msgmod_msg_fini_fp)(nmsg_message_t m, void *msg_clos);
 
typedef nmsg_res (*nmsg_msgmod_field_print_fp)(nmsg_message_t m,
                                               struct nmsg_msgmod_field *field,
                                               void *ptr,
                                               struct nmsg_strbuf *sb,
                                               const char *endline);
 
typedef nmsg_res (*nmsg_msgmod_field_get_fp)(nmsg_message_t m,
                                             struct nmsg_msgmod_field *field,
                                             unsigned val_idx,
                                             void **data,
                                             size_t *len,
                                             void *msg_clos);
 
typedef nmsg_res (*nmsg_msgmod_field_format_fp)(nmsg_message_t m,
                                                struct nmsg_msgmod_field *field,
                                                void *ptr,
                                                struct nmsg_strbuf *sb,
                                                const char *endline);
 
typedef nmsg_res (*nmsg_msgmod_field_parse_fp)(nmsg_message_t m,
                                               struct nmsg_msgmod_field *field,
                                               const char *value,
                                               void **ptr,
                                               size_t *len,
                                               const char *endline);
 
#define NMSG_MSGMOD_FIELD_PRINTER(funcname) \
        nmsg_res funcname(nmsg_message_t m, \
                          struct nmsg_msgmod_field *field, \
                          void *ptr, \
                          struct nmsg_strbuf *sb, \
                          const char *endline)
 
#define NMSG_MSGMOD_FIELD_GETTER(funcname) \
        nmsg_res funcname(nmsg_message_t m, \
                          struct nmsg_msgmod_field *field, \
                          unsigned val_idx, \
                          void **data, \
                          size_t *len, \
                          void *msg_clos)
 
#define NMSG_MSGMOD_FIELD_FORMATTER(funcname) \
        nmsg_res funcname(nmsg_message_t m, \
                          struct nmsg_msgmod_field *field, \
                          void *ptr, \
                          struct nmsg_strbuf *sb, \
                          const char *endline)
 
#define NMSG_MSGMOD_FIELD_PARSER(funcname) \
        nmsg_res funcname(nmsg_message_t m, \
                          struct nmsg_msgmod_field *field, \
                          const char *value, \
                          void **ptr, \
                          size_t *len, \
                          const char *endline)
 
#define NMSG_MSGMOD_REQUIRED_INIT \
        .msgver = NMSG_MSGMOD_VERSION, \
        .protobuf_c_version_number = PROTOBUF_C_VERSION_NUMBER
 
struct nmsg_msgmod_field {
        nmsg_msgmod_field_type                  type;
 
        const char                              *name;
 
        unsigned                                flags;
 
        nmsg_msgmod_field_print_fp              print;
 
        nmsg_msgmod_field_get_fp                get;
 
        const ProtobufCFieldDescriptor          *descr;
 
        /* Optional custom field formatter function. */
        nmsg_msgmod_field_format_fp             format;
 
        /* Optional custom field parser function. */
        nmsg_msgmod_field_parse_fp              parse;
 
        void                                    *_reserved1;
        void                                    *_reserved0;
};
 
#define NMSG_MSGMOD_FIELD_END   { 0, NULL, 0, NULL, NULL, NULL, NULL, NULL, NULL, NULL }
 
typedef enum {
        nmsg_msgmod_type_transparent,
        nmsg_msgmod_type_opaque
} nmsg_msgmod_type;
 
struct nmsg_msgmod_plugin {
        int                                     msgver;
 
        nmsg_msgmod_type                        type;
 
        struct nmsg_idname                      vendor;
 
        struct nmsg_idname                      msgtype;
 
        nmsg_msgmod_init_fp                     init;
 
        nmsg_msgmod_fini_fp                     fini;
 
        nmsg_msgmod_msg_load_fp                 msg_load;
 
        nmsg_msgmod_msg_fini_fp                 msg_fini;
 
        nmsg_msgmod_payload_to_pres_fp          payload_to_pres;
 
        nmsg_msgmod_ipdg_to_payload_fp          ipdg_to_payload;
 
        const ProtobufCMessageDescriptor        *pbdescr;
 
        struct nmsg_msgmod_field                *fields;
 
        nmsg_msgmod_pkt_to_payload_fp           pkt_to_payload;
 
        uint32_t                                protobuf_c_version_number;
 
        nmsg_msgmod_pcap_init_fp                pcap_init;
 
        void                                    *_reserved9;
        void                                    *_reserved8;
        void                                    *_reserved7;
        void                                    *_reserved6;
        void                                    *_reserved5;
        void                                    *_reserved4;
        void                                    *_reserved3;
        void                                    *_reserved2;
        void                                    *_reserved1;
        void                                    *_reserved0;
};
 
#endif /* NMSG_MSGMOD_PLUGIN_H */