Home | History | Annotate | Download | only in lwip
      1 /**
      2  * @file
      3  * Abstract Syntax Notation One (ISO 8824, 8825) codec.
      4  */
      5 
      6 /*
      7  * Copyright (c) 2006 Axon Digital Design B.V., The Netherlands.
      8  * All rights reserved.
      9  *
     10  * Redistribution and use in source and binary forms, with or without modification,
     11  * are permitted provided that the following conditions are met:
     12  *
     13  * 1. Redistributions of source code must retain the above copyright notice,
     14  *    this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright notice,
     16  *    this list of conditions and the following disclaimer in the documentation
     17  *    and/or other materials provided with the distribution.
     18  * 3. The name of the author may not be used to endorse or promote products
     19  *    derived from this software without specific prior written permission.
     20  *
     21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
     22  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
     23  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
     24  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
     25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
     26  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
     29  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
     30  * OF SUCH DAMAGE.
     31  *
     32  * Author: Christiaan Simons <christiaan.simons (at) axon.tv>
     33  */
     34 
     35 #ifndef __LWIP_SNMP_ASN1_H__
     36 #define __LWIP_SNMP_ASN1_H__
     37 
     38 #include "lwip/opt.h"
     39 #include "lwip/err.h"
     40 #include "lwip/pbuf.h"
     41 #include "lwip/snmp.h"
     42 
     43 #if LWIP_SNMP
     44 
     45 #ifdef __cplusplus
     46 extern "C" {
     47 #endif
     48 
     49 #define SNMP_ASN1_UNIV   (0)    /* (!0x80 | !0x40) */
     50 #define SNMP_ASN1_APPLIC (0x40) /* (!0x80 |  0x40) */
     51 #define SNMP_ASN1_CONTXT (0x80) /* ( 0x80 | !0x40) */
     52 
     53 #define SNMP_ASN1_CONSTR (0x20) /* ( 0x20) */
     54 #define SNMP_ASN1_PRIMIT (0)    /* (!0x20) */
     55 
     56 /* universal tags */
     57 #define SNMP_ASN1_INTEG  2
     58 #define SNMP_ASN1_OC_STR 4
     59 #define SNMP_ASN1_NUL    5
     60 #define SNMP_ASN1_OBJ_ID 6
     61 #define SNMP_ASN1_SEQ    16
     62 
     63 /* application specific (SNMP) tags */
     64 #define SNMP_ASN1_IPADDR 0    /* octet string size(4) */
     65 #define SNMP_ASN1_COUNTER 1   /* u32_t */
     66 #define SNMP_ASN1_GAUGE 2     /* u32_t */
     67 #define SNMP_ASN1_TIMETICKS 3 /* u32_t */
     68 #define SNMP_ASN1_OPAQUE 4    /* octet string */
     69 
     70 /* context specific (SNMP) tags */
     71 #define SNMP_ASN1_PDU_GET_REQ 0
     72 #define SNMP_ASN1_PDU_GET_NEXT_REQ 1
     73 #define SNMP_ASN1_PDU_GET_RESP 2
     74 #define SNMP_ASN1_PDU_SET_REQ 3
     75 #define SNMP_ASN1_PDU_TRAP 4
     76 
     77 err_t snmp_asn1_dec_type(struct pbuf *p, u16_t ofs, u8_t *type);
     78 err_t snmp_asn1_dec_length(struct pbuf *p, u16_t ofs, u8_t *octets_used, u16_t *length);
     79 err_t snmp_asn1_dec_u32t(struct pbuf *p, u16_t ofs, u16_t len, u32_t *value);
     80 err_t snmp_asn1_dec_s32t(struct pbuf *p, u16_t ofs, u16_t len, s32_t *value);
     81 err_t snmp_asn1_dec_oid(struct pbuf *p, u16_t ofs, u16_t len, struct snmp_obj_id *oid);
     82 err_t snmp_asn1_dec_raw(struct pbuf *p, u16_t ofs, u16_t len, u16_t raw_len, u8_t *raw);
     83 
     84 void snmp_asn1_enc_length_cnt(u16_t length, u8_t *octets_needed);
     85 void snmp_asn1_enc_u32t_cnt(u32_t value, u16_t *octets_needed);
     86 void snmp_asn1_enc_s32t_cnt(s32_t value, u16_t *octets_needed);
     87 void snmp_asn1_enc_oid_cnt(u8_t ident_len, s32_t *ident, u16_t *octets_needed);
     88 err_t snmp_asn1_enc_type(struct pbuf *p, u16_t ofs, u8_t type);
     89 err_t snmp_asn1_enc_length(struct pbuf *p, u16_t ofs, u16_t length);
     90 err_t snmp_asn1_enc_u32t(struct pbuf *p, u16_t ofs, u16_t octets_needed, u32_t value);
     91 err_t snmp_asn1_enc_s32t(struct pbuf *p, u16_t ofs, u16_t octets_needed, s32_t value);
     92 err_t snmp_asn1_enc_oid(struct pbuf *p, u16_t ofs, u8_t ident_len, s32_t *ident);
     93 err_t snmp_asn1_enc_raw(struct pbuf *p, u16_t ofs, u16_t raw_len, u8_t *raw);
     94 
     95 #ifdef __cplusplus
     96 }
     97 #endif
     98 
     99 #endif /* LWIP_SNMP */
    100 
    101 #endif /* __LWIP_SNMP_ASN1_H__ */
    102