dulvac commented on code in PR #3058: URL: https://github.com/apache/jackrabbit-oak/pull/3058#discussion_r3711523452
########## oak-doc/src/site/markdown/security/audit-design.md: ########## @@ -0,0 +1,435 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +Audit Pipeline Design +-------------------------------------------------------------------------------- + +This document describes the design of Oak's audit pipeline: the SPI surface +in `oak-core-spi`, the security-domain constants in `oak-security-spi`, the +pipeline implementation in `oak-core`, OSGi and embedded wiring, and the +threading and ordering rules the implementation relies on. + +For the consumer-facing guide (event model, listener contract, trust model), +see [Audit SPI](audit.html). + +<a name="overview"></a> +### Overview + +The audit pipeline transports structured `AuditEvent`s from producers to +bundle-registered `AuditEventListener` consumers, gated by a feature toggle +and a per-domain listener registry. + +There are two delivery paths: + +- **Commit-attached.** Oak-internal capture sites (e.g. `UserManagerImpl`) Review Comment: that's a term I made up and never defined. A "capture site" is a place in Oak's own code that records an audit event. Right now the only ones are in `UserManagerImpl`, on group membership add/remove. I'll define it on first use in both pages. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
