src/shared/ask-password-api.h

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