Merge pull request #200 from ueno/wip/merge-crau2

Replace dist/audit.h with the crau library

Author: ueno

README.md

@@ -204,7 +204,7 @@ You can open the generated `flamegraph.html` with your browser.
 ## License
 
 - `agent/src/bpf/audit.bpf.c`: GPL-2.0-or-later
-- `dist/audit.h`: MIT
+- `dist/crau/*`: MIT OR Unlicense
 - `scripts/flamegraph.py`: GPL-2.0-only
 - everything else: GPL-3.0-or-later
 

dist/audit.h

@@ -0,0 +1 @@
+((c-mode . ((c-file-style . "linux"))))

dist/crau/.dir-locals.el

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Daiki Ueno
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dist/crau/LICENSE

@@ -0,0 +1,76 @@
+# crau
+
+`crau` is a header-only library to help define
+[crypto-auditing][crypto-auditing] probes in C applications.
+
+## Getting started
+
+1. Define `ENABLE_CRYPTO_AUDITING` to 1, e.g., through
+   `<config.h>`. Also check if `<sys/sdt.h>` is installed and
+   `DTRACE_PROBE*` macros are defined there.
+
+1. Include `<crau/crau.h>`. One of the C files should define
+   `CRAU_IMPLEMENTATION` to get the functions defined. Also decide
+   where to manage the context stack: if it is part of another struct,
+   add field with type `struct crau_context_stack_st`; if it is
+   maintained globally as thread-local, define a thread-local
+   variable.
+
+1. (Optional) Customize the implementation with configuration macros,
+   e.g., `CRAU_CONTEXT_STACK_DEPTH` for your needs. See
+   `<crau/crau.h>` for the details.
+
+1. Instrument the code as follows. See `<crau/crau.h>` and
+   `<crau/macros.h>` for the documentation:
+
+```c
+/* Public key signing operation starts (but the algorithm is not known yet) */
+crau_new_context_with_data(
+  &stack,
+  "name", CRAU_STRING, "pk::sign",
+  NULL)
+...
+/* Signing algorithm and bits are known at this point */
+crau_data(
+  &stack,
+  "pk::algorithm", CRAU_STRING, "mldsa",
+  "pk::bits", CRAU_WORD, 1952 * 8,
+  NULL)
+
+/* Do the operation */
+sig = mldsa_sign(...);
+
+/* Pop the operation context */
+crau_pop_context(&stack);
+```
+
+## Low level macros
+
+Instead of using those helper functions (`crau_*`), it is also
+possible to directly instrument the library with `CRAU_` macros
+defined in `macros.h`:
+
+```c
+/* Public key signing operation starts (but the algorithm is not known yet) */
+CRAU_NEW_CONTEXT_WITH_DATAV(
+  (long)this_function,
+  (long)parent_function,
+  CRAU_STRING_DATA("name", "pk::sign"));
+...
+/* Signing algorithm and bits are known at this point */
+CRAU_DATAV(
+  (long)this_function,
+  CRAU_STRING_DATA("pk::algorithm", "mldsa"),
+  CRAU_WORD_DATA("pk::bits", 1952 * 8))
+
+/* Do the operation */
+sig = mldsa_sign(...);
+```
+
+Note that those macros don't do context management.
+
+## License
+
+MIT OR Unlicense
+
+[crypto-auditing]: https://github.com/latchset/crypto-auditing

dist/crau/README.md

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org/>