libubox: tests: add more blobmsg/json test cases
[project/libubox.git] / blobmsg.h
index 00e0fdc1d5c65dce44c11e92eefdb1aaa935b856..1f0634d8d066a54b999ee0368ba589299c50e8fe 100644 (file)
--- a/blobmsg.h
+++ b/blobmsg.h
@@ -31,10 +31,11 @@ enum blobmsg_type {
        BLOBMSG_TYPE_INT32,
        BLOBMSG_TYPE_INT16,
        BLOBMSG_TYPE_INT8,
+       BLOBMSG_TYPE_BOOL = BLOBMSG_TYPE_INT8,
        BLOBMSG_TYPE_DOUBLE,
        __BLOBMSG_TYPE_LAST,
        BLOBMSG_TYPE_LAST = __BLOBMSG_TYPE_LAST - 1,
-       BLOBMSG_TYPE_BOOL = BLOBMSG_TYPE_INT8,
+       BLOBMSG_CAST_INT64 = __BLOBMSG_TYPE_LAST,
 };
 
 struct blobmsg_hdr {
@@ -69,6 +70,11 @@ static inline int blobmsg_type(const struct blob_attr *attr)
        return blob_id(attr);
 }
 
+static uint16_t blobmsg_namelen(const struct blobmsg_hdr *hdr)
+{
+       return be16_to_cpu(hdr->namelen);
+}
+
 static inline void *blobmsg_data(const struct blob_attr *attr)
 {
        struct blobmsg_hdr *hdr;
@@ -81,7 +87,7 @@ static inline void *blobmsg_data(const struct blob_attr *attr)
        data = (char *) blob_data(attr);
 
        if (blob_is_extended(attr))
-               data += blobmsg_hdrlen(be16_to_cpu(hdr->namelen));
+               data += blobmsg_hdrlen(blobmsg_namelen(hdr));
 
        return data;
 }
@@ -104,17 +110,66 @@ static inline size_t blobmsg_len(const struct blob_attr *attr)
        return blobmsg_data_len(attr);
 }
 
+/*
+ * blobmsg_check_attr: validate a list of attributes
+ *
+ * This method may be used with trusted data only. Providing
+ * malformed blobs will cause out of bounds memory access.
+ */
 bool blobmsg_check_attr(const struct blob_attr *attr, bool name);
+
+/*
+ * blobmsg_check_attr_len: validate a list of attributes
+ *
+ * This method should be safer implementation of blobmsg_check_attr.
+ * It will limit all memory access performed on the blob to the
+ * range [attr, attr + len] (upper bound non inclusive) and is
+ * thus suited for checking of untrusted blob attributes.
+ */
+bool blobmsg_check_attr_len(const struct blob_attr *attr, bool name, size_t len);
+
+/*
+ * blobmsg_check_attr_list: validate a list of attributes
+ *
+ * This method may be used with trusted data only. Providing
+ * malformed blobs will cause out of bounds memory access.
+ */
 bool blobmsg_check_attr_list(const struct blob_attr *attr, int type);
 
+/*
+ * blobmsg_check_attr_list_len: validate a list of untrusted attributes
+ *
+ * This method should be safer implementation of blobmsg_check_attr_list.
+ * It will limit all memory access performed on the blob to the
+ * range [attr, attr + len] (upper bound non inclusive) and is
+ * thus suited for checking of untrusted blob attributes.
+ */
+bool blobmsg_check_attr_list_len(const struct blob_attr *attr, int type, size_t len);
+
 /*
  * blobmsg_check_array: validate array/table and return size
  *
  * Checks if all elements of an array or table are valid and have
  * the specified type. Returns the number of elements in the array
+ *
+ * This method may be used with trusted data only. Providing
+ * malformed blobs will cause out of bounds memory access.
  */
 int blobmsg_check_array(const struct blob_attr *attr, int type);
 
+/*
+ * blobmsg_check_array_len: validate untrusted array/table and return size
+ *
+ * Checks if all elements of an array or table are valid and have
+ * the specified type. Returns the number of elements in the array.
+ *
+ * This method should be safer implementation of blobmsg_check_array.
+ * It will limit all memory access performed on the blob to the
+ * range [attr, attr + len] (upper bound non inclusive) and is
+ * thus suited for checking of untrusted blob attributes.
+ */
+int blobmsg_check_array_len(const struct blob_attr *attr, int type, size_t len);
+
 int blobmsg_parse(const struct blobmsg_policy *policy, int policy_len,
                   struct blob_attr **tb, void *data, unsigned int len);
 int blobmsg_parse_array(const struct blobmsg_policy *policy, int policy_len,
@@ -234,6 +289,38 @@ static inline uint64_t blobmsg_get_u64(struct blob_attr *attr)
        return tmp;
 }
 
+static inline uint64_t blobmsg_cast_u64(struct blob_attr *attr)
+{
+       uint64_t tmp = 0;
+
+       if (blobmsg_type(attr) == BLOBMSG_TYPE_INT64)
+               tmp = blobmsg_get_u64(attr);
+       else if (blobmsg_type(attr) == BLOBMSG_TYPE_INT32)
+               tmp = blobmsg_get_u32(attr);
+       else if (blobmsg_type(attr) == BLOBMSG_TYPE_INT16)
+               tmp = blobmsg_get_u16(attr);
+       else if (blobmsg_type(attr) == BLOBMSG_TYPE_INT8)
+               tmp = blobmsg_get_u8(attr);
+
+       return tmp;
+}
+
+static inline int64_t blobmsg_cast_s64(struct blob_attr *attr)
+{
+       int64_t tmp = 0;
+
+       if (blobmsg_type(attr) == BLOBMSG_TYPE_INT64)
+               tmp = blobmsg_get_u64(attr);
+       else if (blobmsg_type(attr) == BLOBMSG_TYPE_INT32)
+               tmp = (int32_t)blobmsg_get_u32(attr);
+       else if (blobmsg_type(attr) == BLOBMSG_TYPE_INT16)
+               tmp = (int16_t)blobmsg_get_u16(attr);
+       else if (blobmsg_type(attr) == BLOBMSG_TYPE_INT8)
+               tmp = (int8_t)blobmsg_get_u8(attr);
+
+       return tmp;
+}
+
 static inline double blobmsg_get_double(struct blob_attr *attr)
 {
        union {
@@ -260,9 +347,6 @@ int blobmsg_vprintf(struct blob_buf *buf, const char *name, const char *format,
 int blobmsg_printf(struct blob_buf *buf, const char *name, const char *format, ...)
      __attribute__((format(printf, 3, 4)));
 
-
-/* blobmsg to json formatting */
-
 #define blobmsg_for_each_attr(pos, attr, rem) \
        for (rem = attr ? blobmsg_data_len(attr) : 0, \
             pos = (struct blob_attr *) (attr ? blobmsg_data(attr) : NULL); \
@@ -270,4 +354,10 @@ int blobmsg_printf(struct blob_buf *buf, const char *name, const char *format, .
             (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
             rem -= blob_pad_len(pos), pos = blob_next(pos))
 
+#define __blobmsg_for_each_attr(pos, attr, rem) \
+       for (pos = (struct blob_attr *) (attr ? blobmsg_data(attr) : NULL); \
+            rem >= sizeof(struct blob_attr) && (blob_pad_len(pos) <= rem) && \
+            (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
+            rem -= blob_pad_len(pos), pos = blob_next(pos))
+
 #endif