[thirdparty/systemd.git] / src / shared / ask-password-api.h

/* SPDX-License-Identifier: LGPL-2.1-or-later */
#pragma once

#include <stdbool.h>

#include "time-util.h"

typedef enum AskPasswordFlags {
        ASK_PASSWORD_ACCEPT_CACHED = 1 << 0, /* read from kernel keyring */
        ASK_PASSWORD_PUSH_CACHE    = 1 << 1, /* write to kernel keyring after getting password from elsewhere */
        ASK_PASSWORD_ECHO          = 1 << 2, /* show the password literally while reading, instead of "*" */
        ASK_PASSWORD_SILENT        = 1 << 3, /* do no show any password at all while reading */
        ASK_PASSWORD_NO_TTY        = 1 << 4, /* never ask for password on tty */
        ASK_PASSWORD_NO_AGENT      = 1 << 5, /* never ask for password via agent */
        ASK_PASSWORD_CONSOLE_COLOR = 1 << 6, /* Use color if /dev/console points to a console that supports color */
        ASK_PASSWORD_NO_CREDENTIAL = 1 << 7, /* never use $CREDENTIALS_DIRECTORY data */
        ASK_PASSWORD_HIDE_EMOJI    = 1 << 8, /* hide the lock and key emoji */
} AskPasswordFlags;

int ask_password_tty(int tty_fd, const char *message, const char *key_name, usec_t until, AskPasswordFlags flags, const char *flag_file, char ***ret);
int ask_password_plymouth(const char *message, usec_t until, AskPasswordFlags flags, const char *flag_file, char ***ret);
int ask_password_agent(const char *message, const char *icon, const char *id, const char *key_name, usec_t until, AskPasswordFlags flag, char ***ret);
int ask_password_auto(const char *message, const char *icon, const char *id, const char *key_name, const char *credential_name, usec_t until, AskPasswordFlags flag, char ***ret);
Commit	Line	Data
	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	} AskPasswordFlags;
	19
	20	int ask_password_tty(int tty_fd, const char message, const char key_name, usec_t until, AskPasswordFlags flags, const char flag_file, char **ret);
	21	int ask_password_plymouth(const char message, usec_t until, AskPasswordFlags flags, const char flag_file, char ***ret);
	22	int ask_password_agent(const char message, const char icon, const char id, const char key_name, usec_t until, AskPasswordFlags flag, char ***ret);
	23	int ask_password_auto(const char message, const char icon, const char id, const char key_name, const char credential_name, usec_t until, AskPasswordFlags flag, char **ret);