| 1 |
/* SPDX-License-Identifier: LGPL-2.1-or-later */ |
| 2 |
#pragma once |
| 3 |
|
| 4 |
#include "shared-forward.h" |
| 5 |
|
| 6 |
typedef enum AskPasswordFlags { |
| 7 |
ASK_PASSWORD_ACCEPT_CACHED = 1 << 0, /* read from kernel keyring */ |
| 8 |
ASK_PASSWORD_PUSH_CACHE = 1 << 1, /* write to kernel keyring after getting password from elsewhere */ |
| 9 |
ASK_PASSWORD_ECHO = 1 << 2, /* show the password literally while reading, instead of "*" */ |
| 10 |
ASK_PASSWORD_SILENT = 1 << 3, /* do no show any password at all while reading */ |
| 11 |
ASK_PASSWORD_NO_TTY = 1 << 4, /* never ask for password on tty */ |
| 12 |
ASK_PASSWORD_NO_AGENT = 1 << 5, /* never ask for password via agent */ |
| 13 |
ASK_PASSWORD_CONSOLE_COLOR = 1 << 6, /* Use color if /dev/console points to a console that supports color */ |
| 14 |
ASK_PASSWORD_NO_CREDENTIAL = 1 << 7, /* never use $CREDENTIALS_DIRECTORY data */ |
| 15 |
ASK_PASSWORD_HIDE_EMOJI = 1 << 8, /* hide the lock and key emoji */ |
| 16 |
ASK_PASSWORD_HEADLESS = 1 << 9, /* headless mode: never query interactively */ |
| 17 |
ASK_PASSWORD_USER = 1 << 10, /* query only our own agents, not any system password agents */ |
| 18 |
} AskPasswordFlags; |
| 19 |
|
| 20 |
/* Encapsulates the mostly static fields of a password query */ |
| 21 |
typedef struct AskPasswordRequest { |
| 22 |
const char *message; /* The human-readable password prompt when asking interactively */ |
| 23 |
const char *keyring; /* kernel keyring key name (key of "user" type) */ |
| 24 |
const char *icon; /* freedesktop icon spec name */ |
| 25 |
const char *id; /* some identifier used for this prompt for the "ask-password" protocol */ |
| 26 |
const char *credential; /* $CREDENTIALS_DIRECTORY credential name */ |
| 27 |
const char *flag_file; /* Once this flag file disappears abort the query */ |
| 28 |
int tty_fd; /* If querying on a TTY, the TTY to query on (or -EBADF) */ |
| 29 |
int hup_fd; /* An extra fd to watch for POLLHUP, in which case to abort the query */ |
| 30 |
usec_t until; /* CLOCK_MONOTONIC time until which to show the prompt (if zero: forever) */ |
| 31 |
} AskPasswordRequest; |
| 32 |
|
| 33 |
int ask_password_tty(const AskPasswordRequest *req, AskPasswordFlags flags, char ***ret); |
| 34 |
int ask_password_plymouth(const AskPasswordRequest *req, AskPasswordFlags flags, char ***ret); |
| 35 |
int ask_password_agent(const AskPasswordRequest *req, AskPasswordFlags flags, char ***ret); |
| 36 |
int ask_password_auto(const AskPasswordRequest *req, AskPasswordFlags flags, char ***ret); |
| 37 |
|
| 38 |
int acquire_user_ask_password_directory(char **ret); |