lib/audit_logging/audit_logging.h

   1 /*
   2    common routines for audit logging
   3
   4    Copyright (C) Andrew Bartlett <abartlet@samba.org> 2018
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19 #ifndef _AUDIT_LOGGING_H_
  20 #define _AUDIT_LOGGING_H_
  21 #include <talloc.h>
  22 #include "lib/messaging/irpc.h"
  23 #include "lib/tsocket/tsocket.h"
  24 #include "lib/util/attr.h"
  25
  26 _WARN_UNUSED_RESULT_ char *audit_get_timestamp(TALLOC_CTX *frame);
  27 void audit_log_human_text(const char *prefix,
  28                           const char *message,
  29                           int debug_class,
  30                           int debug_level);
  31
  32 #ifdef HAVE_JANSSON
  33 #include <jansson.h>
  34 /*
  35  * Wrapper for jannson JSON object
  36  *
  37  */
  38 struct json_object {
  39         json_t *root;
  40         bool valid;
  41 };
  42 extern const struct json_object json_empty_object;
  43
  44 #define JSON_ERROR -1
  45
  46 void audit_log_json(struct json_object *message,
  47                     int debug_class,
  48                     int debug_level);
  49 void audit_message_send(struct imessaging_context *msg_ctx,
  50                         const char *server_name,
  51                         uint32_t message_type,
  52                         struct json_object *message);
  53 _WARN_UNUSED_RESULT_ struct json_object json_new_object(void);
  54 _WARN_UNUSED_RESULT_ struct json_object json_new_array(void);
  55 void json_free(struct json_object *object);
  56 void json_assert_is_array(struct json_object *array);
  57 _WARN_UNUSED_RESULT_ bool json_is_invalid(const struct json_object *object);
  58
  59 _WARN_UNUSED_RESULT_ int json_add_int(struct json_object *object,
  60                                       const char *name,
  61                                       const json_int_t value);
  62 _WARN_UNUSED_RESULT_ int json_add_bool(struct json_object *object,
  63                                        const char *name,
  64                                        const bool value);
  65 _WARN_UNUSED_RESULT_ int json_add_optional_bool(struct json_object *object,
  66                                                 const char *name,
  67                                                 const bool *value);
  68 _WARN_UNUSED_RESULT_ int json_add_string(struct json_object *object,
  69                                          const char *name,
  70                                          const char *value);
  71 _WARN_UNUSED_RESULT_ int json_add_object(struct json_object *object,
  72                                          const char *name,
  73                                          struct json_object *value);
  74 _WARN_UNUSED_RESULT_ int json_add_stringn(struct json_object *object,
  75                                           const char *name,
  76                                           const char *value,
  77                                           const size_t len);
  78 _WARN_UNUSED_RESULT_ int json_add_version(struct json_object *object,
  79                                           int major,
  80                                           int minor);
  81 _WARN_UNUSED_RESULT_ int json_add_timestamp(struct json_object *object);
  82 _WARN_UNUSED_RESULT_ int json_add_address(
  83     struct json_object *object,
  84     const char *name,
  85     const struct tsocket_address *address);
  86 _WARN_UNUSED_RESULT_ int json_add_sid(struct json_object *object,
  87                                       const char *name,
  88                                       const struct dom_sid *sid);
  89 _WARN_UNUSED_RESULT_ int json_add_guid(struct json_object *object,
  90                                        const char *name,
  91                                        const struct GUID *guid);
  92
  93 _WARN_UNUSED_RESULT_ int json_add_flags32(struct json_object *object,
  94                                           const char *name,
  95                                           uint32_t flags);
  96
  97 _WARN_UNUSED_RESULT_ int json_update_object(struct json_object *object,
  98                                             const char *key,
  99                                             struct json_object *new_obj);
 100
 101 _WARN_UNUSED_RESULT_ struct json_object json_get_array(
 102     struct json_object *object, const char *name);
 103 _WARN_UNUSED_RESULT_ struct json_object json_get_object(
 104     struct json_object *object, const char *name);
 105 _WARN_UNUSED_RESULT_ char *json_to_string(TALLOC_CTX *mem_ctx,
 106                                           const struct json_object *object);
 107 #endif
 108 #endif