cribra 0.3.0

Privacy-first Rust core for detecting, querying, and safely transforming secrets and sensitive data
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175

# Cribra contributor/development commands.
# `just` is preferred locally; this Makefile mirrors the common recipes.

.PHONY: help fmt fmt-check check check-all capi capi-header capi-header-check \
	capi-smoke capi-symbols capi-static capi-smoke-all test test-serde test-all test-doc \
	clippy doc doc-all wasm wasm-serde msrv audit package package-dirty \
	publish-dry-run publish-dry-run-dirty gate release-gate bench bench-v02 \
	bench-diagnostics bench-all clean

help:
	@printf '%s\n' \
	  'Common Cribra targets:' \
	  '  make gate              Local quality gate' \
	  '  make release-gate      Full release gate (requires cargo-audit)' \
	  '  make capi              Check/lint/build native C adapter' \
	  '  make capi-header       Generate include/cribra.h with cbindgen' \
	  '  make capi-header-check Verify committed C header is deterministic' \
	  '  make capi-smoke        Build/run the real C ABI smoke consumer' \
	  '  make capi-symbols      Verify generated/native ABI symbol parity' \
	  '  make capi-static       Verify native static library artifact' \
	  '  make capi-smoke-all    Run the complete local C ABI smoke surface' \
	  '  make test-all          Test all native core features' \
	  '  make wasm              Check default WASM contract' \
	  '  make wasm-serde        Check WASM + Serde contract' \
	  '  make msrv              Check/test Rust 1.97.0' \
	  '  make audit             Run cargo audit' \
	  '  make package           Verify crate package' \
	  '  make publish-dry-run   crates.io dry run' \
	  '  make bench-all         Run maintained benchmarks' \
	  '  make clean             Remove Cargo build artifacts'

fmt:
	cargo fmt --all

fmt-check:
	cargo fmt --all -- --check

check:
	cargo check

check-all:
	cargo check --all-features

# Check that the native C adapter can be statically linked.
capi-static:
capi:
	cargo check -p cribra-capi
	cargo clippy -p cribra-capi --all-targets -- -D warnings
	cargo build -p cribra-capi

# Run benchmarks for the native C adapter.
capi-bench:
	cargo bench -p cribra-capi --bench abi

# Generate the committed native C header from the Rust ABI adapter.
capi-header:
	mkdir -p include
	cbindgen --config crates/cribra-capi/cbindgen.toml --crate cribra-capi --output include/cribra.h

# Check that the committed native C header matches the generated one.
capi-header-check:
	mkdir -p target/c-smoke
	cp include/cribra.h target/c-smoke/cribra.h.expected
	cbindgen --config crates/cribra-capi/cbindgen.toml --crate cribra-capi --output target/c-smoke/cribra.h.generated
	diff -u target/c-smoke/cribra.h.expected target/c-smoke/cribra.h.generated

# Smoke test the native C adapter.
capi-smoke: capi-header
	cargo build -p cribra-capi
	mkdir -p target/c-smoke
	@if [ "$$(uname -s)" = "Darwin" ]; then \
		clang -std=c11 -Wall -Wextra -Werror -Iinclude \
		  crates/cribra-capi/tests/c/smoke.c \
		  -Ltarget/debug -lcribra_capi \
		  -Wl,-rpath,@loader_path/../debug \
		  -o target/c-smoke/cribra-smoke; \
	elif [ "$$(uname -s)" = "Linux" ]; then \
		cc -std=c11 -Wall -Wextra -Werror -Iinclude \
		  crates/cribra-capi/tests/c/smoke.c \
		  -Ltarget/debug -lcribra_capi \
		  -Wl,-rpath,'$$ORIGIN/../debug' \
		  -o target/c-smoke/cribra-smoke; \
	else \
		echo "capi-smoke local target currently supports macOS and Linux; Windows is covered in CI"; \
		exit 2; \
	fi
	target/c-smoke/cribra-smoke

# Check that the native C adapter exports the expected symbols.
capi-symbols: capi-header
	cargo build -p cribra-capi
	sh crates/cribra-capi/tests/c/check-capi-symbols.sh

# Check that the native C adapter can be statically linked.
capi-static:
	cargo build -p cribra-capi
	test -f target/debug/libcribra_capi.a

capi-smoke-all: capi-header-check capi-smoke capi-symbols capi-static

test:
	cargo test

test-serde:
	cargo test --features serde

test-all:
	cargo test --all-features

test-doc:
	cargo test --doc

clippy:
	cargo clippy --all-targets --all-features -- -D warnings

doc:
	cargo doc --no-default-features --no-deps

doc-all:
	cargo doc --all-features --no-deps

# Check that the WASM adapter exports the expected symbols.
wasm:
	cargo check --target wasm32-unknown-unknown --no-default-features

# Check that the WASM adapter exports the expected symbols.
wasm-symbols:
	cargo check --target wasm32-unknown-unknown --no-default-features

# Check that the WASM adapter can be used with serde.
wasm-serde:
	cargo check --target wasm32-unknown-unknown --no-default-features --features serde

# Check that the MSRV requirements are met.
msrv:
	cargo +1.97.0 check
	cargo +1.97.0 check --all-features
	cargo +1.97.0 test
	cargo +1.97.0 test --all-features

audit:
	cargo audit

package:
	cargo package

package-dirty:
	cargo package --allow-dirty

publish-dry-run:
	cargo publish --dry-run

publish-dry-run-dirty:
	cargo publish --dry-run --allow-dirty

# Gate the release process.
gate: fmt-check check-all capi test test-serde test-all test-doc clippy doc doc-all wasm wasm-serde
	git diff --check

release-gate: gate msrv audit package publish-dry-run

bench:
	cargo bench --bench scan --all-features

bench-v02:
	cargo bench --bench v02 --all-features

bench-diagnostics:
	cargo bench --bench isolation --all-features
	cargo bench --bench contextual_tail --all-features

bench-all: bench bench-v02 bench-diagnostics

clean:
	cargo clean