add_key
Implemented in Antinomie 0.7.0 · Syscall list
Synopsis
Section titled “Synopsis”long add_key(const char *_type, const char *_description, const void *_payload, size_t plen, key_serial_t destringid);| Number (x86-64) | 248 |
| ABI | common |
| Kernel entry point | sys_add_key |
This is the raw kernel prototype from the pinned Linux 6.12.94 schema, not the libc wrapper.
Description
Section titled “Description”Adds a key of a given type and description to a keyring.
Arguments
Section titled “Arguments”| Name | Type | Meaning |
|---|---|---|
_type (arg0) |
const char * |
Key type, as a string. |
_description (arg1) |
const char * |
Key description, as a string. |
_payload (arg2) |
const void * |
Pointer to the key payload. |
plen (arg3) |
size_t |
Payload length. |
destringid (arg4) |
key_serial_t |
Destination keyring id. |
Return value
Section titled “Return value”On success: the serial number of the key.
In an Antinomie trace the Return column and the ret filter field show the raw kernel return value. On failure that is the negative errno, for example -2 for ENOENT, not the -1 plus errno that the libc wrapper gives. syscall.errno holds the positive errno and syscall.success is false.
Common errors
Section titled “Common errors”| Raw return | Name | Meaning |
|---|---|---|
-13 |
EACCES |
Permission denied. |
-122 |
EDQUOT |
A quota was exceeded. |
Man page
Section titled “Man page”Captured by Antinomie
Section titled “Captured by Antinomie”Coverage mark: Implemented. Every pointer argument has a capture rule in the pinned kernel patch and none of them records a “no decoder”, “address only” or “not observed” gap on any code path. Individual values can still be incomplete on a particular call; see the capture statuses.
Every call is recorded as an Entry record (the six argument words and the pointees copied at entry) and an Exit record (the return value and the pointees copied at exit).
Arguments
Section titled “Arguments”| Argument | When | How | Recorded field key | Condition |
|---|---|---|---|---|
_type (arg0) |
Entry | the pointer itself, as a raw word | args.0, args.raw[0] |
|
| ↳ pointee | Entry | NUL-terminated string, up to 32 bytes | arg0.path |
always |
_description (arg1) |
Entry | the pointer itself, as a raw word | args.1, args.raw[1] |
|
| ↳ pointee | Entry | NUL-terminated string, up to 4,096 bytes | arg1.path |
always |
_payload (arg2) |
Entry | the pointer itself, as a raw word | args.2, args.raw[2] |
|
| ↳ pointee | Entry | buffer, length from plen (arg3), limit 1 MiB - 1 bytes |
arg2.data |
always |
plen (arg3) |
Entry | raw scalar word | args.3, args.plen |
|
destringid (arg4) |
Entry | raw scalar word | args.4, args.destringid |
Filter fields
Section titled “Filter fields”- Result:
ret,syscall.errno,syscall.success,syscall.duration_ns. - Argument words:
args._type(arg0),args._description(arg1),args._payload(arg2),args.plen(arg3),args.destringid(arg4);args.0toargs.5by position. - Captured strings: the
args.<name>field of a path argument, andargs.path, give the captured text instead of the pointer.
See Syscall Trace filter for the full syntax.
For what the capture statuses mean, see Capture statuses. For what is never recorded, see Known gaps.