Skip to content

Commit

Permalink
api: improve process.uid and process_credentials documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Djalal Harouni <tixxdz@gmail.com>
  • Loading branch information
tixxdz committed Jun 21, 2024
1 parent a8200d8 commit d308a15
Show file tree
Hide file tree
Showing 8 changed files with 98 additions and 80 deletions.
20 changes: 10 additions & 10 deletions api/v1/README.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 13 additions & 10 deletions api/v1/tetragon/tetragon.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 13 additions & 10 deletions api/v1/tetragon/tetragon.proto
Original file line number Diff line number Diff line change
Expand Up @@ -112,21 +112,21 @@ message UserNamespace {
}

message ProcessCredentials {
// The real user ID
// The real user ID of the process' owner.
google.protobuf.UInt32Value uid = 1;
// The real group ID
// The real group ID of the process' owner.
google.protobuf.UInt32Value gid = 2;
// The effective user ID
// The effective user ID used for permission checks.
google.protobuf.UInt32Value euid = 3;
// The effective group ID
// The effective group ID used for permission checks.
google.protobuf.UInt32Value egid = 4;
// The saved user ID
// The saved user ID.
google.protobuf.UInt32Value suid = 5;
// The saved group ID
// The saved group ID.
google.protobuf.UInt32Value sgid = 6;
// the filesystem user ID
// the filesystem user ID used for filesystem access checks. Usually equals the euid.
google.protobuf.UInt32Value fsuid = 7;
// The filesystem group ID
// The filesystem group ID used for filesystem access checks. Usually equals the egid.
google.protobuf.UInt32Value fsgid = 8;
// Secure management flags
repeated SecureBitsType securebits = 9;
Expand Down Expand Up @@ -178,7 +178,9 @@ message Process {
string exec_id = 1;
// Process identifier from host PID namespace.
google.protobuf.UInt32Value pid = 2;
// User identifier associated with the process.
// The effective User identifier used for permission checks. This field maps to the
// 'ProcessCredentials.euid' field. Run with the `--enable-process-cred` flag to
// enable 'ProcessCredentials' and get all the User and Group identifiers.
google.protobuf.UInt32Value uid = 3;
// Current working directory of the process.
string cwd = 4;
Expand Down Expand Up @@ -262,7 +264,8 @@ message Process {
Namespaces ns = 15;
// Thread ID, note that for the thread group leader, tid is equal to pid.
google.protobuf.UInt32Value tid = 16;
// Process credentials
// Process credentials, disabled by default, can be enabled by the
// `--enable-process-cred` flag.
ProcessCredentials process_credentials = 17;
// Executed binary properties. This field is only available on ProcessExec events.
BinaryProperties binary_properties = 18;
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 10 additions & 10 deletions docs/content/en/docs/reference/grpc-api.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit d308a15

Please sign in to comment.