agt_ypsnmp_util.h

Go to the documentation of this file.

/*****************************************************************************
Various copyrights apply to this package, listed in various separate
parts below.  Please make sure that you read all the parts.
 
---- Part 1: Sparta, Inc (BSD) -----
 
Copyright (c) 2003-2010, Sparta, Inc
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
*  Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.
 
*  Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
 
*  Neither the name of Sparta, Inc nor the names of its contributors may
   be used to endorse or promote products derived from this software
   without specific prior written permission.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
---- Part 2: ScienceLogic, LLC (BSD) ----
 
Copyright (c) 2006, ScienceLogic, LLC
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
 
*  Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.
 
*  Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
 
*  Neither the name of ScienceLogic, LLC nor the names of its
   contributors may be used to endorse or promote products derived
   from this software without specific prior written permission.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.
*************************************************************************/
 
 
/*************************************************************************
   OVERVIEW
 
    This module implements Utility Functions for YP SNMP
 
*************************************************************************/
 
 
/*
 * Copyright (c) 2017 - 2020, YumaWorks. Inc., All Rights Reserved.
 *
 * 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.
 */
 
#if defined(WITH_SNMP) && defined(WITH_RESTCONF)
#ifndef _H_agt_ypsnmp_util
#define _H_agt_ypsnmp_util
 
/*  FILE: agt_ypsnmp_util.h
*********************************************************************
*                                                                   *
*                         P U R P O S E                             *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                   C H A N G E         H I S T O R Y               *
*                                                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
10May17      am       begun;
 
*/
 
#ifndef _H_status_enum
#include "status_enum.h"
#endif
 
#ifndef _H_yangapi
#include "yangapi.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                                                   *
*                         C O N S T A N T S                         *
*                                                                   *
*********************************************************************/
 
#define YPSNMP_TYPE_GAUGE32     (const xmlChar *)"gauge32"
#define YPSNMP_TYPE_GAUGE64     (const xmlChar *)"gauge64"
#define YPSNMP_TYPE_PHYS_ADDR   (const xmlChar *)"phys-address"
#define YPSNMP_TYPE_TIMETICKS   (const xmlChar *)"timeticks"
#define YPSNMP_TYPE_TIMESTAMP   (const xmlChar *)"timestamp"
#define YPSNMP_TYPE_COUNTER32   (const xmlChar *)"counter32"
#define YPSNMP_TYPE_ZBCOUNTER32 (const xmlChar *)"zero-based-counter32"
#define YPSNMP_TYPE_COUNTER64   (const xmlChar *)"counter64"
#define YPSNMP_TYPE_ZBCOUNTER64 (const xmlChar *)"zero-based-counter64"
#define YPSNMP_TYPE_OID128      (const xmlChar *)"object-identifier-128"
 
#define YPSNMP_APP_NAME  (const char *)"snmpd"
 
 
/* max number of cache_entry_t in snmp_cacheQ */
#define MAX_SNMP_CACHE_SIZE     32
#define ADDR_BUFLEN 128
 
/* mac address */
#define YPSNMP_PHYS_ADDR_LEN    6
 
/* work around for the way fd_set is accessed in
 * net-snmp/include/net-snmp/library/large_fd_set.h
 */
#define fds_bits __fds_bits
 
    /*
     *  Definitions for Agent Extensibility Protocol (RFC 2257)
     *
     */
 
/* currently only TCP endpoint is available
    UDP is not working for AgentX protocol, the master cannot
    trasfer packets via UDP.
    The AgentX default socket is /var/agentx/master which
    has to be changed to TCP type socket!!!!!! (tcp:localhost:705)
 
*/
#define YPSNMP_AGENTX_SOCKET  (const char *)"tcp:localhost:705"
#define YPSNMP_AGENTX_NAME    (const char *)"agentx"
 
    /*
     * AgentX versions
     */
    /*
     * Use values distinct from those used to represent SNMP versions
     */
 
#define AGENTX_VERSION_BASE 192     /* Binary: 11xxxxxx */
#define AGENTX_VERSION_1    (AGENTX_VERSION_BASE | 0x1)
 
#define IS_AGENTX_VERSION(v)    (((v)&AGENTX_VERSION_BASE) == AGENTX_VERSION_BASE)
 
    /*
     * PDU types in AgentX
     */
#define AGENTX_MSG_OPEN                 ((u_char)1)
#define AGENTX_MSG_CLOSE                ((u_char)2)
#define AGENTX_MSG_REGISTER             ((u_char)3)
#define AGENTX_MSG_UNREGISTER           ((u_char)4)
#define AGENTX_MSG_GET                  ((u_char)5)
#define AGENTX_MSG_GETNEXT              ((u_char)6)
#define AGENTX_MSG_GETBULK              ((u_char)7)
#define AGENTX_MSG_TESTSET              ((u_char)8)
#define AGENTX_MSG_COMMITSET            ((u_char)9)
#define AGENTX_MSG_UNDOSET              ((u_char)10)
#define AGENTX_MSG_CLEANUPSET           ((u_char)11)
#define AGENTX_MSG_NOTIFY               ((u_char)12)
#define AGENTX_MSG_PING                 ((u_char)13)
#define AGENTX_MSG_INDEX_ALLOCATE       ((u_char)14)
#define AGENTX_MSG_INDEX_DEALLOCATE     ((u_char)15)
#define AGENTX_MSG_ADD_AGENT_CAPS       ((u_char)16)
#define AGENTX_MSG_REMOVE_AGENT_CAPS    ((u_char)17)
#define AGENTX_MSG_RESPONSE             ((u_char)18)
 
    /*
     * Error codes from RFC 2257
     */
#define AGENTX_ERR_OPEN_FAILED                  (256)
#define AGENTX_ERR_NOT_OPEN                     (257)
#define AGENTX_ERR_INDEX_WRONG_TYPE             (258)
#define AGENTX_ERR_INDEX_ALREADY_ALLOCATED      (259)
#define AGENTX_ERR_INDEX_NONE_AVAILABLE         (260)
#define AGENTX_ERR_INDEX_NOT_ALLOCATED          (261)
#define AGENTX_ERR_UNSUPPORTED_CONTEXT          (262)
#define AGENTX_ERR_DUPLICATE_REGISTRATION       (263)
#define AGENTX_ERR_UNKNOWN_REGISTRATION         (264)
#define AGENTX_ERR_UNKNOWN_AGENTCAPS            (265)
 
    /*
     * added in 1999 revision
     */
#define AGENTX_ERR_NOERROR              SNMP_ERR_NOERROR
#define AGENTX_ERR_PARSE_FAILED                 (266)
#define AGENTX_ERR_REQUEST_DENIED               (267)
#define AGENTX_ERR_PROCESSING_ERROR             (268)
 
    /*
     * Message processing models
     */
#define AGENTX_MP_MODEL_AGENTXv1                (257)
 
 
    /*
     * PDU Flags
     */
#define AGENTX_MSG_FLAG_INSTANCE_REGISTER       0x01
#define AGENTX_MSG_FLAG_NEW_INSTANCE            0x02
#define AGENTX_MSG_FLAG_ANY_INSTANCE            0x04
#define AGENTX_MSG_FLAG_NON_DEFAULT_CONTEXT     0x08
#define AGENTX_MSG_FLAG_NETWORK_BYTE_ORDER      0x10
 
#define AGENTX_MSG_FLAGS_MASK                   0xff
 
    /*
     * Session Flags
     */
#define AGENTX_FLAGS_NETWORK_BYTE_ORDER   AGENTX_MSG_FLAG_NETWORK_BYTE_ORDER
 
 
/********************************************************************
*                                                                   *
*                           T Y P E S                               *
*                                                                   *
*********************************************************************/
 
typedef enum ypsnmp_getnext_mode_t_ {
    YPSNMP_MODE_NONE,
 
    YPSNMP_MODE_TAB_NOINDEX,
 
    YPSNMP_MODE_TAB_INDEXED,
 
    YPSNMP_MODE_SCAL_NOINDEX,
 
    YPSNMP_MODE_SCAL_INDEXED,
 
    YPSNMP_MODE_COMPLEX
} ypsnmp_getnext_mode_t;
 
 
typedef struct agent_nsap_t_ {
 
    int                      handle;
 
    netsnmp_transport       *transport;
 
    void                    *opaque_ses;
 
    struct agent_nsap_t_    *next;
} agent_nsap_t;
 
 
typedef struct ypsnmp_agent_session_t_ {
    int              mode;
 
    netsnmp_session *session;
 
    netsnmp_pdu     *pdu;
 
    int              rw;
 
    int              exact;
 
    int              status;
 
    int              index;
 
    int              oldmode;
 
    int              vbcount;
 
    int              original_command;
 
} ypsnmp_agent_session_t;
 
 
/********************************************************************
*                                                                   *
*                        F U N C T I O N S                          *
*                                                                   *
*********************************************************************/
 
 
extern val_value_t *
    agt_ypsnmp_bestmatch_next_index (yangapi_cb_t *rcb);
 
 
extern val_value_t *
    agt_ypsnmp_get_first_getnextlist (yangapi_cb_t *rcb);
 
 
extern val_value_t *
    agt_ypsnmp_get_next_getnextlist (val_value_t *list);
 
 
extern boolean
    agt_ypsnmp_match_obj (obj_template_t *targetobj,
                          obj_template_t *curobj);
 
 
extern boolean
    agt_ypsnmp_match_index (yangapi_cb_t *rcb,
                            val_value_t *keyval);
 
 
extern obj_template_t *
    agt_ypsnmp_get_table_obj (obj_template_t *obj);
 
 
extern obj_template_t *
    agt_ypsnmp_get_parent_obj (obj_template_t *obj);
 
 
extern boolean
    agt_ypsnmp_is_scalar_obj (obj_template_t *curobj);
 
 
extern boolean
    agt_ypsnmp_is_augmented_obj (obj_template_t *curobj);
 
 
extern xmlChar *
    agt_ypsnmp_convert_physaddr (val_value_t *val);
 
 
extern netsnmp_variable_list *
    agt_ypsnmp_create_snmp_varbind_object (const oid *name,
                                           size_t name_length,
                                           u_char type,
                                           const void *value,
                                           size_t len);
 
 
extern void
    agt_ypsnmp_append_varbind_to_list (netsnmp_variable_list **list,
                                       netsnmp_variable_list *var);
 
 
extern obj_oid_t *
    agt_ypsnmp_convert_varbind_to_oid (netsnmp_variable_list *var_ptr);
 
 
extern status_t
    agt_ypsnmp_set_varbind (ses_cb_t *scb,
                            netsnmp_pdu *pdu,
                            val_value_t *val,
                            const obj_oid_t *oid_obj);
 
 
extern status_t
    agt_ypsnmp_setup_peeraddr (ses_cb_t *scb,
                               netsnmp_pdu *pdu);
 
 
extern yangapi_method_t
    agt_ypsnmp_get_yangapi_method (uint8 msg_code);
 
 
extern xmlChar *
    agt_ypsnmp_make_restconf_uri (obj_template_t *obj);
 
 
extern void
    agt_ypsnmp_log_pdu (netsnmp_pdu *pdu);
 
 
extern const void *
    agt_ypsnmp_get_varbind_value (netsnmp_variable_list *var);
 
 
extern const xmlChar *
    agt_ypsnmp_get_getnext_modename (ypsnmp_getnext_mode_t getnextmode);
 
 
extern obj_oid_t *
    agt_ypsnmp_get_index_oid (obj_oid_t *full_oid,
                              uint32 index_length);
 
 
extern status_t
    agt_ypsnmp_convert_oid2chars (xmlChar *str,
                                  uint32 len,
                                  const oid_t *useoid);
 
 
extern status_t
    agt_ypsnmp_convert_str_oid2str (xmlChar *str,
                                    uint32 len,
                                    oid_t *useoid);
 
 
extern status_t
    agt_ypsnmp_convert_str2oid (const xmlChar *str,
                                oid_t *useoid,
                                uint32 len);
 
 
extern status_t
    agt_ypsnmp_indexoid_to_value (yangapi_cb_t *rcb,
                                  obj_template_t *obj,
                                  uint32 index_length);
 
 
extern status_t
    agt_ypsnmp_value_to_indexoid (yangapi_cb_t *rcb,
                                  val_value_t *list);
 
 
extern ypsnmp_agent_session_t *
    agt_ypsnmp_init_agent_session (netsnmp_session * session,
                                   netsnmp_pdu *pdu);
 
 
extern void
    agt_ypsnmp_free_agent_session (ypsnmp_agent_session_t *asp);
 
 
extern void free_varbind (netsnmp_variable_list *var);
 
 
void free_varbind_yp (netsnmp_variable_list *var);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif  // _H_agt_ypsnmp_util
#endif  // defined(WITH_SNMP) && defined(WITH_RESTCONF)