mirror/lwip
1
0
Fork 0
mirror of https://github.com/lwip-tcpip/lwip.git synced 2024-10-06 06:39:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Reduce code duplication in SNMP agent traps implementation.

Browse Source 
See patch #9038: SNMP Traps with varbinds, file #37748 by Marco Veeneman
This commit is contained in:
Marco Veeneman 2016-07-07 21:00:07 +02:00 committed by Dirk Ziegelmeier
parent 98e92f6550
commit dcd52510ce
3 changed files with 72 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
src/apps/snmp/snmp_msg.c
View File

@ -1167,31 +1167,24 @@ snmp_prepare_outbound_frame(struct snmp_request *request)
return ERR_OK; return ERR_OK;
} }
#define OVB_BUILD_EXEC(code) BUILD_EXEC(code, ERR_ARG)
err_t err_t
snmp_append_outbound_varbind(struct snmp_pbuf_stream *pbuf_stream, struct snmp_varbind* varbind) snmp_length_outbound_varbind(struct snmp_varbind *varbind, struct snmp_varbind_len *len)
{ {
struct snmp_asn1_tlv tlv;
u8_t vb_len_len, oid_len_len, value_len_len;
u16_t vb_value_len, oid_value_len, value_value_len;
/* calculate required lengths */ /* calculate required lengths */
snmp_asn1_enc_oid_cnt(varbind->oid.id, varbind->oid.len, &oid_value_len); snmp_asn1_enc_oid_cnt(varbind->oid.id, varbind->oid.len, &len->oid_value_len);
snmp_asn1_enc_length_cnt(oid_value_len, &oid_len_len); snmp_asn1_enc_length_cnt(len->oid_value_len, &len->oid_len_len);
if (varbind->value_len == 0) { if (varbind->value_len == 0) {
value_value_len = 0; len->value_value_len = 0;
} else if (varbind->value_len & SNMP_GET_VALUE_RAW_DATA) { } else if (varbind->value_len & SNMP_GET_VALUE_RAW_DATA) {
value_value_len = varbind->value_len & (~SNMP_GET_VALUE_RAW_DATA); len->value_value_len = varbind->value_len & (~SNMP_GET_VALUE_RAW_DATA);
} else { } else {
switch (varbind->type) switch (varbind->type) {
{
case SNMP_ASN1_TYPE_INTEGER: case SNMP_ASN1_TYPE_INTEGER:
if (varbind->value_len != sizeof (s32_t)) { if (varbind->value_len != sizeof (s32_t)) {
return ERR_VAL; return ERR_VAL;
} }
snmp_asn1_enc_s32t_cnt(*((s32_t*)varbind->value) , &value_value_len); snmp_asn1_enc_s32t_cnt(*((s32_t*) varbind->value), &len->value_value_len);
break; break;
case SNMP_ASN1_TYPE_COUNTER: case SNMP_ASN1_TYPE_COUNTER:
case SNMP_ASN1_TYPE_GAUGE: case SNMP_ASN1_TYPE_GAUGE:
@ -1199,86 +1192,103 @@ snmp_append_outbound_varbind(struct snmp_pbuf_stream *pbuf_stream, struct snmp_v
if (varbind->value_len != sizeof (u32_t)) { if (varbind->value_len != sizeof (u32_t)) {
return ERR_VAL; return ERR_VAL;
} }
snmp_asn1_enc_u32t_cnt(*((u32_t*)varbind->value) , &value_value_len); snmp_asn1_enc_u32t_cnt(*((u32_t*) varbind->value), &len->value_value_len);
break; break;
case SNMP_ASN1_TYPE_OCTET_STRING: case SNMP_ASN1_TYPE_OCTET_STRING:
case SNMP_ASN1_TYPE_IPADDR: case SNMP_ASN1_TYPE_IPADDR:
case SNMP_ASN1_TYPE_OPAQUE: case SNMP_ASN1_TYPE_OPAQUE:
value_value_len = varbind->value_len; len->value_value_len = varbind->value_len;
break; break;
case SNMP_ASN1_TYPE_NULL: case SNMP_ASN1_TYPE_NULL:
if (varbind->value_len != 0) { if (varbind->value_len != 0) {
return ERR_VAL; return ERR_VAL;
} }
value_value_len = 0; len->value_value_len = 0;
break; break;
case SNMP_ASN1_TYPE_OBJECT_ID: case SNMP_ASN1_TYPE_OBJECT_ID:
if ((varbind->value_len & 0x03) != 0) { if ((varbind->value_len & 0x03) != 0) {
return ERR_VAL; return ERR_VAL;
} }
snmp_asn1_enc_oid_cnt((u32_t*)varbind->value, varbind->value_len >> 2, &value_value_len); snmp_asn1_enc_oid_cnt((u32_t*) varbind->value, varbind->value_len >> 2, &len->value_value_len);
break; break;
case SNMP_ASN1_TYPE_COUNTER64: case SNMP_ASN1_TYPE_COUNTER64:
if (varbind->value_len != (2 * sizeof (u32_t))) { if (varbind->value_len != (2 * sizeof (u32_t))) {
return ERR_VAL; return ERR_VAL;
} }
snmp_asn1_enc_u64t_cnt((u32_t*)varbind->value , &value_value_len); snmp_asn1_enc_u64t_cnt((u32_t*) varbind->value, &len->value_value_len);
break; break;
default: default:
/* unsupported type */ /* unsupported type */
return ERR_VAL; return ERR_VAL;
} }
} }
snmp_asn1_enc_length_cnt(value_value_len, &value_len_len); snmp_asn1_enc_length_cnt(len->value_value_len, &len->value_len_len);
vb_value_len = 1 + oid_len_len + oid_value_len + 1 + value_len_len + value_value_len; len->vb_value_len = 1 + len->oid_len_len + len->oid_value_len + 1 + len->value_len_len + len->value_value_len;
snmp_asn1_enc_length_cnt(vb_value_len, &vb_len_len); snmp_asn1_enc_length_cnt(len->vb_value_len, &len->vb_len_len);
return ERR_OK;
}
#define OVB_BUILD_EXEC(code) BUILD_EXEC(code, ERR_ARG)
err_t
snmp_append_outbound_varbind(struct snmp_pbuf_stream *pbuf_stream, struct snmp_varbind* varbind)
{
struct snmp_asn1_tlv tlv;
struct snmp_varbind_len len;
err_t err;
err = snmp_length_outbound_varbind(varbind, &len);
if (err != ERR_OK) {
return err;
}
/* check length already before adding first data because in case of GetBulk, /* check length already before adding first data because in case of GetBulk,
* data added so far is returned and therefore no partial data shall be added * data added so far is returned and therefore no partial data shall be added
*/ */
if ((1 + vb_len_len + vb_value_len) > pbuf_stream->length) { if ((1 + len.vb_len_len + len.vb_value_len) > pbuf_stream->length) {
return ERR_BUF; return ERR_BUF;
} }
/* 'VarBind' sequence */ /* 'VarBind' sequence */
SNMP_ASN1_SET_TLV_PARAMS(tlv, SNMP_ASN1_TYPE_SEQUENCE, vb_len_len, vb_value_len); SNMP_ASN1_SET_TLV_PARAMS(tlv, SNMP_ASN1_TYPE_SEQUENCE, len.vb_len_len, len.vb_value_len);
OVB_BUILD_EXEC(snmp_ans1_enc_tlv(pbuf_stream, &tlv)); OVB_BUILD_EXEC(snmp_ans1_enc_tlv(pbuf_stream, &tlv));
/* VarBind OID */ /* VarBind OID */
SNMP_ASN1_SET_TLV_PARAMS(tlv, SNMP_ASN1_TYPE_OBJECT_ID, oid_len_len, oid_value_len); SNMP_ASN1_SET_TLV_PARAMS(tlv, SNMP_ASN1_TYPE_OBJECT_ID, len.oid_len_len, len.oid_value_len);
OVB_BUILD_EXEC(snmp_ans1_enc_tlv(pbuf_stream, &tlv)); OVB_BUILD_EXEC(snmp_ans1_enc_tlv(pbuf_stream, &tlv));
OVB_BUILD_EXEC(snmp_asn1_enc_oid(pbuf_stream, varbind->oid.id, varbind->oid.len)); OVB_BUILD_EXEC(snmp_asn1_enc_oid(pbuf_stream, varbind->oid.id, varbind->oid.len));
/* VarBind value */ /* VarBind value */
SNMP_ASN1_SET_TLV_PARAMS(tlv, varbind->type, value_len_len, value_value_len); SNMP_ASN1_SET_TLV_PARAMS(tlv, varbind->type, len.value_len_len, len.value_value_len);
OVB_BUILD_EXEC(snmp_ans1_enc_tlv(pbuf_stream, &tlv)); OVB_BUILD_EXEC(snmp_ans1_enc_tlv(pbuf_stream, &tlv));
if (value_value_len > 0) { if (len.value_value_len > 0) {
if (varbind->value_len & SNMP_GET_VALUE_RAW_DATA) { if (varbind->value_len & SNMP_GET_VALUE_RAW_DATA) {
OVB_BUILD_EXEC( snmp_asn1_enc_raw(pbuf_stream, (u8_t*)varbind->value, value_value_len) ); OVB_BUILD_EXEC(snmp_asn1_enc_raw(pbuf_stream, (u8_t*) varbind->value, len.value_value_len));
} else { } else {
switch (varbind->type) switch (varbind->type) {
{
case SNMP_ASN1_TYPE_INTEGER: case SNMP_ASN1_TYPE_INTEGER:
OVB_BUILD_EXEC( snmp_asn1_enc_s32t(pbuf_stream, value_value_len, *((s32_t*)varbind->value)) ); OVB_BUILD_EXEC(snmp_asn1_enc_s32t(pbuf_stream, len.value_value_len, *((s32_t*) varbind->value)));
break; break;
case SNMP_ASN1_TYPE_COUNTER: case SNMP_ASN1_TYPE_COUNTER:
case SNMP_ASN1_TYPE_GAUGE: case SNMP_ASN1_TYPE_GAUGE:
case SNMP_ASN1_TYPE_TIMETICKS: case SNMP_ASN1_TYPE_TIMETICKS:
OVB_BUILD_EXEC( snmp_asn1_enc_u32t(pbuf_stream, value_value_len, *((u32_t*)varbind->value)) ); OVB_BUILD_EXEC(snmp_asn1_enc_u32t(pbuf_stream, len.value_value_len, *((u32_t*) varbind->value)));
break; break;
case SNMP_ASN1_TYPE_OCTET_STRING: case SNMP_ASN1_TYPE_OCTET_STRING:
case SNMP_ASN1_TYPE_IPADDR: case SNMP_ASN1_TYPE_IPADDR:
case SNMP_ASN1_TYPE_OPAQUE: case SNMP_ASN1_TYPE_OPAQUE:
OVB_BUILD_EXEC( snmp_asn1_enc_raw(pbuf_stream, (u8_t*)varbind->value, value_value_len) ); OVB_BUILD_EXEC(snmp_asn1_enc_raw(pbuf_stream, (u8_t*) varbind->value, len.value_value_len));
value_value_len = varbind->value_len; len.value_value_len = varbind->value_len;
break; break;
case SNMP_ASN1_TYPE_OBJECT_ID: case SNMP_ASN1_TYPE_OBJECT_ID:
OVB_BUILD_EXEC(snmp_asn1_enc_oid(pbuf_stream, (u32_t*) varbind->value, varbind->value_len / sizeof (u32_t))); OVB_BUILD_EXEC(snmp_asn1_enc_oid(pbuf_stream, (u32_t*) varbind->value, varbind->value_len / sizeof (u32_t)));
break; break;
case SNMP_ASN1_TYPE_COUNTER64: case SNMP_ASN1_TYPE_COUNTER64:
OVB_BUILD_EXEC( snmp_asn1_enc_u64t(pbuf_stream, value_value_len, (u32_t*)varbind->value) ); OVB_BUILD_EXEC(snmp_asn1_enc_u64t(pbuf_stream, len.value_value_len, (u32_t*) varbind->value));
break; break;
default: default:
LWIP_ASSERT("Unknown variable type", 0); LWIP_ASSERT("Unknown variable type", 0);

11
src/apps/snmp/snmp_msg.h
View File

@ -160,6 +160,16 @@ struct snmp_request
u8_t value_buffer[SNMP_MAX_VALUE_SIZE]; u8_t value_buffer[SNMP_MAX_VALUE_SIZE];
}; };
struct snmp_varbind_len
{
u8_t vb_len_len;
u16_t vb_value_len;
u8_t oid_len_len;
u16_t oid_value_len;
u8_t value_len_len;
u16_t value_value_len;
};
/** Agent community string */ /** Agent community string */
extern const char *snmp_community; extern const char *snmp_community;
/** Agent community string for write access */ /** Agent community string for write access */
@ -170,6 +180,7 @@ extern void* snmp_traps_handle;
void snmp_receive(void *handle, struct pbuf *p, const ip_addr_t *source_ip, u16_t port); void snmp_receive(void *handle, struct pbuf *p, const ip_addr_t *source_ip, u16_t port);
err_t snmp_sendto(void *handle, struct pbuf *p, const ip_addr_t *dst, u16_t port); err_t snmp_sendto(void *handle, struct pbuf *p, const ip_addr_t *dst, u16_t port);
u8_t snmp_get_local_ip_for_dst(void* handle, const ip_addr_t *dst, ip_addr_t *result); u8_t snmp_get_local_ip_for_dst(void* handle, const ip_addr_t *dst, ip_addr_t *result);
err_t snmp_length_outbound_varbind(struct snmp_varbind *varbind, struct snmp_varbind_len *len);
err_t snmp_append_outbound_varbind(struct snmp_pbuf_stream *pbuf_stream, struct snmp_varbind* varbind); err_t snmp_append_outbound_varbind(struct snmp_pbuf_stream *pbuf_stream, struct snmp_varbind* varbind);
#ifdef __cplusplus #ifdef __cplusplus

72
src/apps/snmp/snmp_traps.c
View File

@ -245,72 +245,6 @@ snmp_authfail_trap(void)
} }
} }
static u16_t
snmp_varbind_len(struct snmp_varbind *varbind)
{
u8_t vb_len_len, oid_len_len, value_len_len;
u16_t vb_value_len, oid_value_len, value_value_len;
/* calculate required lengths */
snmp_asn1_enc_oid_cnt(varbind->oid.id, varbind->oid.len, &oid_value_len);
snmp_asn1_enc_length_cnt(oid_value_len, &oid_len_len);
if (varbind->value_len == 0) {
value_value_len = 0;
} else if (varbind->value_len & SNMP_GET_VALUE_RAW_DATA) {
value_value_len = varbind->value_len & (~SNMP_GET_VALUE_RAW_DATA);
} else {
switch (varbind->type) {
case SNMP_ASN1_TYPE_INTEGER:
if (varbind->value_len != sizeof (s32_t)) {
return 0;
}
snmp_asn1_enc_s32t_cnt(*((s32_t*) varbind->value), &value_value_len);
break;
case SNMP_ASN1_TYPE_COUNTER:
case SNMP_ASN1_TYPE_GAUGE:
case SNMP_ASN1_TYPE_TIMETICKS:
if (varbind->value_len != sizeof (u32_t)) {
return 0;
}
snmp_asn1_enc_u32t_cnt(*((u32_t*) varbind->value), &value_value_len);
break;
case SNMP_ASN1_TYPE_OCTET_STRING:
case SNMP_ASN1_TYPE_IPADDR:
case SNMP_ASN1_TYPE_OPAQUE:
value_value_len = varbind->value_len;
break;
case SNMP_ASN1_TYPE_NULL:
if (varbind->value_len != 0) {
return 0;
}
value_value_len = 0;
break;
case SNMP_ASN1_TYPE_OBJECT_ID:
if ((varbind->value_len & 0x03) != 0) {
return 0;
}
snmp_asn1_enc_oid_cnt((u32_t*) varbind->value, varbind->value_len >> 2, &value_value_len);
break;
case SNMP_ASN1_TYPE_COUNTER64:
if (varbind->value_len != (2 * sizeof (u32_t))) {
return 0;
}
snmp_asn1_enc_u64t_cnt((u32_t*) varbind->value, &value_value_len);
break;
default:
/* unsupported type */
return 0;
}
}
snmp_asn1_enc_length_cnt(value_value_len, &value_len_len);
vb_value_len = 1 + oid_len_len + oid_value_len + 1 + value_len_len + value_value_len;
snmp_asn1_enc_length_cnt(vb_value_len, &vb_len_len);
return 1 + vb_len_len + vb_value_len;
}
static u16_t static u16_t
snmp_trap_varbind_sum(struct snmp_msg_trap *trap, struct snmp_varbind *varbinds) snmp_trap_varbind_sum(struct snmp_msg_trap *trap, struct snmp_varbind *varbinds)
{ {
@ -321,7 +255,11 @@ snmp_trap_varbind_sum(struct snmp_msg_trap *trap, struct snmp_varbind *varbinds)
tot_len = 0; tot_len = 0;
varbind = varbinds; varbind = varbinds;
while (varbind != NULL) { while (varbind != NULL) {
tot_len += snmp_varbind_len(varbind); struct snmp_varbind_len len;
if (snmp_length_outbound_varbind(varbind, &len) == ERR_OK) {
tot_len += 1 + len.vb_len_len + len.vb_value_len;
}
varbind = varbind->next; varbind = varbind->next;
} }