| 1 |
/* SPDX-License-Identifier: LGPL-2.1-or-later */ |
| 2 |
|
| 3 |
#include "bus-polkit.h" |
| 4 |
#include "varlink-io.systemd.AskPassword.h" |
| 5 |
|
| 6 |
static SD_VARLINK_DEFINE_ENUM_TYPE( |
| 7 |
EchoMode, |
| 8 |
SD_VARLINK_FIELD_COMMENT("Request that the password is prompted for without any visual feedback"), |
| 9 |
SD_VARLINK_DEFINE_ENUM_VALUE(off), |
| 10 |
SD_VARLINK_FIELD_COMMENT("Show the password in plaintext as it is typed in"), |
| 11 |
SD_VARLINK_DEFINE_ENUM_VALUE(on), |
| 12 |
SD_VARLINK_FIELD_COMMENT("Provide visual feedback as the password is typed, but mask the password plaintext"), |
| 13 |
SD_VARLINK_DEFINE_ENUM_VALUE(masked)); |
| 14 |
|
| 15 |
static SD_VARLINK_DEFINE_METHOD( |
| 16 |
Ask, |
| 17 |
SD_VARLINK_FIELD_COMMENT("The message to show when prompting for the password"), |
| 18 |
SD_VARLINK_DEFINE_INPUT(message, SD_VARLINK_STRING, SD_VARLINK_NULLABLE), |
| 19 |
SD_VARLINK_FIELD_COMMENT("The name for the kernel keyring entry used for caching"), |
| 20 |
SD_VARLINK_DEFINE_INPUT(keyname, SD_VARLINK_STRING, SD_VARLINK_NULLABLE), |
| 21 |
SD_VARLINK_FIELD_COMMENT("The icon name to display, following the freedesktop.org icon naming specification"), |
| 22 |
SD_VARLINK_DEFINE_INPUT(icon, SD_VARLINK_STRING, SD_VARLINK_NULLABLE), |
| 23 |
SD_VARLINK_FIELD_COMMENT("An recognizable id for the password prompt"), |
| 24 |
SD_VARLINK_DEFINE_INPUT(id, SD_VARLINK_STRING, SD_VARLINK_NULLABLE), |
| 25 |
SD_VARLINK_FIELD_COMMENT("Timeout in µs (relative, CLOCK_MONOTONIC; set to zero to only check cache and not query interactively; set to UINT64_MAX to disable relative timeout; if not set defaults to 90s)"), |
| 26 |
SD_VARLINK_DEFINE_INPUT(timeoutUSec, SD_VARLINK_INT, SD_VARLINK_NULLABLE), |
| 27 |
SD_VARLINK_FIELD_COMMENT("Timeout in µs (absolute, CLOCK_MONOTONIC; if both timeoutUSec and untilUSec are specified the earlier of the two is used; " |
| 28 |
"set to zero to only check cache and not query interactively; leave unset or set to UINT64_MAX to disable absolute timeout)"), |
| 29 |
SD_VARLINK_DEFINE_INPUT(untilUSec, SD_VARLINK_INT, SD_VARLINK_NULLABLE), |
| 30 |
SD_VARLINK_FIELD_COMMENT("Whether to accept cached passwords from the kernel keyring"), |
| 31 |
SD_VARLINK_DEFINE_INPUT(acceptCached, SD_VARLINK_BOOL, SD_VARLINK_NULLABLE), |
| 32 |
SD_VARLINK_FIELD_COMMENT("Whether to push acquired passwords into the kernel keyring"), |
| 33 |
SD_VARLINK_DEFINE_INPUT(pushCache, SD_VARLINK_BOOL, SD_VARLINK_NULLABLE), |
| 34 |
SD_VARLINK_FIELD_COMMENT("Whether to give visual feedback when typing in the password"), |
| 35 |
SD_VARLINK_DEFINE_INPUT_BY_TYPE(echo, EchoMode, SD_VARLINK_NULLABLE), |
| 36 |
VARLINK_DEFINE_POLKIT_INPUT, |
| 37 |
SD_VARLINK_FIELD_COMMENT("List of acquired passwords. This typically contains one entry, but might contain more in case multiple passwords were previously cached."), |
| 38 |
SD_VARLINK_DEFINE_OUTPUT(passwords, SD_VARLINK_STRING, SD_VARLINK_ARRAY)); |
| 39 |
|
| 40 |
static SD_VARLINK_DEFINE_ERROR(NoPasswordAvailable); |
| 41 |
static SD_VARLINK_DEFINE_ERROR(TimeoutReached); |
| 42 |
|
| 43 |
SD_VARLINK_DEFINE_INTERFACE( |
| 44 |
io_systemd_AskPassword, |
| 45 |
"io.systemd.AskPassword", |
| 46 |
SD_VARLINK_INTERFACE_COMMENT("An interface for interactively asking the user for a password"), |
| 47 |
SD_VARLINK_SYMBOL_COMMENT("Encodes whether to provide visual feedback as the password is typed in"), |
| 48 |
&vl_type_EchoMode, |
| 49 |
SD_VARLINK_SYMBOL_COMMENT("Interactively ask the user for a password, or answer from a previously cached entry"), |
| 50 |
&vl_method_Ask, |
| 51 |
SD_VARLINK_SYMBOL_COMMENT("No password available, because none was provided in the cache, and no agent was asked"), |
| 52 |
&vl_error_NoPasswordAvailable, |
| 53 |
SD_VARLINK_SYMBOL_COMMENT("Query timeout reached, user did not provide a password in time"), |
| 54 |
&vl_error_TimeoutReached); |