1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
7 #include "ask-password-api.h"
8 #include "bus-common-errors.h"
10 #include "bus-locator.h"
11 #include "cgroup-util.h"
12 #include "dns-domain.h"
16 #include "format-table.h"
18 #include "glyph-util.h"
19 #include "home-util.h"
20 #include "homectl-fido2.h"
21 #include "homectl-pkcs11.h"
22 #include "homectl-recovery-key.h"
23 #include "libfido2-util.h"
24 #include "locale-util.h"
25 #include "main-func.h"
26 #include "memory-util.h"
28 #include "parse-argument.h"
29 #include "parse-util.h"
30 #include "path-util.h"
31 #include "percent-util.h"
32 #include "pkcs11-util.h"
33 #include "pretty-print.h"
34 #include "process-util.h"
35 #include "pwquality-util.h"
36 #include "rlimit-util.h"
37 #include "spawn-polkit-agent.h"
38 #include "terminal-util.h"
39 #include "uid-alloc-range.h"
40 #include "user-record-pwquality.h"
41 #include "user-record-show.h"
42 #include "user-record-util.h"
43 #include "user-record.h"
44 #include "user-util.h"
47 static PagerFlags arg_pager_flags
= 0;
48 static bool arg_legend
= true;
49 static bool arg_ask_password
= true;
50 static BusTransport arg_transport
= BUS_TRANSPORT_LOCAL
;
51 static const char *arg_host
= NULL
;
52 static const char *arg_identity
= NULL
;
53 static JsonVariant
*arg_identity_extra
= NULL
;
54 static JsonVariant
*arg_identity_extra_privileged
= NULL
;
55 static JsonVariant
*arg_identity_extra_this_machine
= NULL
;
56 static JsonVariant
*arg_identity_extra_rlimits
= NULL
;
57 static char **arg_identity_filter
= NULL
; /* this one is also applied to 'privileged' and 'thisMachine' subobjects */
58 static char **arg_identity_filter_rlimits
= NULL
;
59 static uint64_t arg_disk_size
= UINT64_MAX
;
60 static uint64_t arg_disk_size_relative
= UINT64_MAX
;
61 static char **arg_pkcs11_token_uri
= NULL
;
62 static char **arg_fido2_device
= NULL
;
63 static Fido2EnrollFlags arg_fido2_lock_with
= FIDO2ENROLL_PIN
| FIDO2ENROLL_UP
;
64 static bool arg_recovery_key
= false;
65 static JsonFormatFlags arg_json_format_flags
= JSON_FORMAT_OFF
;
66 static bool arg_and_resize
= false;
67 static bool arg_and_change_password
= false;
69 EXPORT_FORMAT_FULL
, /* export the full record */
70 EXPORT_FORMAT_STRIPPED
, /* strip "state" + "binding", but leave signature in place */
71 EXPORT_FORMAT_MINIMAL
, /* also strip signature */
72 } arg_export_format
= EXPORT_FORMAT_FULL
;
74 STATIC_DESTRUCTOR_REGISTER(arg_identity_extra
, json_variant_unrefp
);
75 STATIC_DESTRUCTOR_REGISTER(arg_identity_extra_this_machine
, json_variant_unrefp
);
76 STATIC_DESTRUCTOR_REGISTER(arg_identity_extra_privileged
, json_variant_unrefp
);
77 STATIC_DESTRUCTOR_REGISTER(arg_identity_extra_rlimits
, json_variant_unrefp
);
78 STATIC_DESTRUCTOR_REGISTER(arg_identity_filter
, strv_freep
);
79 STATIC_DESTRUCTOR_REGISTER(arg_identity_filter_rlimits
, strv_freep
);
80 STATIC_DESTRUCTOR_REGISTER(arg_pkcs11_token_uri
, strv_freep
);
81 STATIC_DESTRUCTOR_REGISTER(arg_fido2_device
, strv_freep
);
83 static const BusLocator
*bus_mgr
;
85 static bool identity_properties_specified(void) {
88 !json_variant_is_blank_object(arg_identity_extra
) ||
89 !json_variant_is_blank_object(arg_identity_extra_privileged
) ||
90 !json_variant_is_blank_object(arg_identity_extra_this_machine
) ||
91 !json_variant_is_blank_object(arg_identity_extra_rlimits
) ||
92 !strv_isempty(arg_identity_filter
) ||
93 !strv_isempty(arg_identity_filter_rlimits
) ||
94 !strv_isempty(arg_pkcs11_token_uri
) ||
95 !strv_isempty(arg_fido2_device
);
98 static int acquire_bus(sd_bus
**bus
) {
106 r
= bus_connect_transport(arg_transport
, arg_host
, false, bus
);
108 return bus_log_connect_error(r
, arg_transport
);
110 (void) sd_bus_set_allow_interactive_authorization(*bus
, arg_ask_password
);
115 static int list_homes(int argc
, char *argv
[], void *userdata
) {
116 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
117 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
118 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
119 _cleanup_(table_unrefp
) Table
*table
= NULL
;
122 r
= acquire_bus(&bus
);
126 r
= bus_call_method(bus
, bus_mgr
, "ListHomes", &error
, &reply
, NULL
);
128 return log_error_errno(r
, "Failed to list homes: %s", bus_error_message(&error
, r
));
130 table
= table_new("name", "uid", "gid", "state", "realname", "home", "shell");
134 r
= sd_bus_message_enter_container(reply
, 'a', "(susussso)");
136 return bus_log_parse_error(r
);
139 const char *name
, *state
, *realname
, *home
, *shell
, *color
;
143 r
= sd_bus_message_read(reply
, "(susussso)", &name
, &uid
, &state
, &gid
, &realname
, &home
, &shell
, NULL
);
145 return bus_log_parse_error(r
);
149 r
= table_add_many(table
,
154 return table_log_add_error(r
);
157 r
= table_add_cell(table
, &cell
, TABLE_STRING
, state
);
159 return table_log_add_error(r
);
161 color
= user_record_state_color(state
);
163 (void) table_set_color(table
, cell
, color
);
165 r
= table_add_many(table
,
166 TABLE_STRING
, strna(empty_to_null(realname
)),
168 TABLE_STRING
, strna(empty_to_null(shell
)));
170 return table_log_add_error(r
);
173 r
= sd_bus_message_exit_container(reply
);
175 return bus_log_parse_error(r
);
177 if (table_get_rows(table
) > 1 || !FLAGS_SET(arg_json_format_flags
, JSON_FORMAT_OFF
)) {
178 r
= table_set_sort(table
, (size_t) 0);
180 return table_log_sort_error(r
);
182 r
= table_print_with_pager(table
, arg_json_format_flags
, arg_pager_flags
, arg_legend
);
187 if (arg_legend
&& (arg_json_format_flags
& JSON_FORMAT_OFF
)) {
188 if (table_get_rows(table
) > 1)
189 printf("\n%zu home areas listed.\n", table_get_rows(table
) - 1);
191 printf("No home areas.\n");
197 static int acquire_existing_password(
198 const char *user_name
,
200 bool emphasize_current
,
201 AskPasswordFlags flags
) {
203 _cleanup_(strv_free_erasep
) char **password
= NULL
;
204 _cleanup_(erase_and_freep
) char *envpw
= NULL
;
205 _cleanup_free_
char *question
= NULL
;
211 r
= getenv_steal_erase("PASSWORD", &envpw
);
213 return log_error_errno(r
, "Failed to acquire password from environment: %m");
215 /* People really shouldn't use environment variables for passing passwords. We support this
216 * only for testing purposes, and do not document the behaviour, so that people won't
217 * actually use this outside of testing. */
219 r
= user_record_set_password(hr
, STRV_MAKE(envpw
), true);
221 return log_error_errno(r
, "Failed to store password: %m");
226 /* If this is not our own user, then don't use the password cache */
227 if (is_this_me(user_name
) <= 0)
228 SET_FLAG(flags
, ASK_PASSWORD_ACCEPT_CACHED
|ASK_PASSWORD_PUSH_CACHE
, false);
230 if (asprintf(&question
, emphasize_current
?
231 "Please enter current password for user %s:" :
232 "Please enter password for user %s:",
236 r
= ask_password_auto(question
,
237 /* icon= */ "user-home",
239 /* key_name= */ "home-password",
240 /* credential_name= */ "home.password",
244 if (r
== -EUNATCH
) { /* EUNATCH is returned if no password was found and asking interactively was
245 * disabled via the flags. Not an error for us. */
246 log_debug_errno(r
, "No passwords acquired.");
250 return log_error_errno(r
, "Failed to acquire password: %m");
252 r
= user_record_set_password(hr
, password
, true);
254 return log_error_errno(r
, "Failed to store password: %m");
259 static int acquire_recovery_key(
260 const char *user_name
,
262 AskPasswordFlags flags
) {
264 _cleanup_(strv_free_erasep
) char **recovery_key
= NULL
;
265 _cleanup_(erase_and_freep
) char *envpw
= NULL
;
266 _cleanup_free_
char *question
= NULL
;
272 r
= getenv_steal_erase("PASSWORD", &envpw
);
274 return log_error_errno(r
, "Failed to acquire password from environment: %m");
276 /* People really shouldn't use environment variables for passing secrets. We support this
277 * only for testing purposes, and do not document the behaviour, so that people won't
278 * actually use this outside of testing. */
280 r
= user_record_set_password(hr
, STRV_MAKE(envpw
), true); /* recovery keys are stored in the record exactly like regular passwords! */
282 return log_error_errno(r
, "Failed to store recovery key: %m");
287 /* If this is not our own user, then don't use the password cache */
288 if (is_this_me(user_name
) <= 0)
289 SET_FLAG(flags
, ASK_PASSWORD_ACCEPT_CACHED
|ASK_PASSWORD_PUSH_CACHE
, false);
291 if (asprintf(&question
, "Please enter recovery key for user %s:", user_name
) < 0)
294 r
= ask_password_auto(question
,
295 /* icon= */ "user-home",
297 /* key_name= */ "home-recovery-key",
298 /* credential_name= */ "home.recovery-key",
302 if (r
== -EUNATCH
) { /* EUNATCH is returned if no recovery key was found and asking interactively was
303 * disabled via the flags. Not an error for us. */
304 log_debug_errno(r
, "No recovery keys acquired.");
308 return log_error_errno(r
, "Failed to acquire recovery keys: %m");
310 r
= user_record_set_password(hr
, recovery_key
, true);
312 return log_error_errno(r
, "Failed to store recovery keys: %m");
317 static int acquire_token_pin(
318 const char *user_name
,
320 AskPasswordFlags flags
) {
322 _cleanup_(strv_free_erasep
) char **pin
= NULL
;
323 _cleanup_(erase_and_freep
) char *envpin
= NULL
;
324 _cleanup_free_
char *question
= NULL
;
330 r
= getenv_steal_erase("PIN", &envpin
);
332 return log_error_errno(r
, "Failed to acquire PIN from environment: %m");
334 r
= user_record_set_token_pin(hr
, STRV_MAKE(envpin
), false);
336 return log_error_errno(r
, "Failed to store token PIN: %m");
341 /* If this is not our own user, then don't use the password cache */
342 if (is_this_me(user_name
) <= 0)
343 SET_FLAG(flags
, ASK_PASSWORD_ACCEPT_CACHED
|ASK_PASSWORD_PUSH_CACHE
, false);
345 if (asprintf(&question
, "Please enter security token PIN for user %s:", user_name
) < 0)
348 r
= ask_password_auto(
350 /* icon= */ "user-home",
352 /* key_name= */ "token-pin",
353 /* credential_name= */ "home.token-pin",
357 if (r
== -EUNATCH
) { /* EUNATCH is returned if no PIN was found and asking interactively was disabled
358 * via the flags. Not an error for us. */
359 log_debug_errno(r
, "No security token PINs acquired.");
363 return log_error_errno(r
, "Failed to acquire security token PIN: %m");
365 r
= user_record_set_token_pin(hr
, pin
, false);
367 return log_error_errno(r
, "Failed to store security token PIN: %m");
372 static int handle_generic_user_record_error(
373 const char *user_name
,
375 const sd_bus_error
*error
,
377 bool emphasize_current_password
) {
383 if (sd_bus_error_has_name(error
, BUS_ERROR_HOME_ABSENT
))
384 return log_error_errno(SYNTHETIC_ERRNO(EREMOTE
),
385 "Home of user %s is currently absent, please plug in the necessary storage device or backing file system.", user_name
);
387 else if (sd_bus_error_has_name(error
, BUS_ERROR_AUTHENTICATION_LIMIT_HIT
))
388 return log_error_errno(SYNTHETIC_ERRNO(ETOOMANYREFS
),
389 "Too frequent login attempts for user %s, try again later.", user_name
);
391 else if (sd_bus_error_has_name(error
, BUS_ERROR_BAD_PASSWORD
)) {
393 if (!strv_isempty(hr
->password
))
394 log_notice("Password incorrect or not sufficient, please try again.");
396 /* Don't consume cache entries or credentials here, we already tried that unsuccessfully. But
397 * let's push what we acquire here into the cache */
398 r
= acquire_existing_password(
401 emphasize_current_password
,
402 ASK_PASSWORD_PUSH_CACHE
| ASK_PASSWORD_NO_CREDENTIAL
);
406 } else if (sd_bus_error_has_name(error
, BUS_ERROR_BAD_RECOVERY_KEY
)) {
408 if (!strv_isempty(hr
->password
))
409 log_notice("Recovery key incorrect or not sufficient, please try again.");
411 /* Don't consume cache entries or credentials here, we already tried that unsuccessfully. But
412 * let's push what we acquire here into the cache */
413 r
= acquire_recovery_key(
416 ASK_PASSWORD_PUSH_CACHE
| ASK_PASSWORD_NO_CREDENTIAL
);
420 } else if (sd_bus_error_has_name(error
, BUS_ERROR_BAD_PASSWORD_AND_NO_TOKEN
)) {
422 if (strv_isempty(hr
->password
))
423 log_notice("Security token not inserted, please enter password.");
425 log_notice("Password incorrect or not sufficient, and configured security token not inserted, please try again.");
427 r
= acquire_existing_password(
430 emphasize_current_password
,
431 ASK_PASSWORD_PUSH_CACHE
| ASK_PASSWORD_NO_CREDENTIAL
);
435 } else if (sd_bus_error_has_name(error
, BUS_ERROR_TOKEN_PIN_NEEDED
)) {
437 /* First time the PIN is requested, let's accept cached data, and allow using credential store */
438 r
= acquire_token_pin(
441 ASK_PASSWORD_ACCEPT_CACHED
| ASK_PASSWORD_PUSH_CACHE
);
445 } else if (sd_bus_error_has_name(error
, BUS_ERROR_TOKEN_PROTECTED_AUTHENTICATION_PATH_NEEDED
)) {
447 log_notice("%s%sPlease authenticate physically on security token.",
448 emoji_enabled() ? special_glyph(SPECIAL_GLYPH_TOUCH
) : "",
449 emoji_enabled() ? " " : "");
451 r
= user_record_set_pkcs11_protected_authentication_path_permitted(hr
, true);
453 return log_error_errno(r
, "Failed to set PKCS#11 protected authentication path permitted flag: %m");
455 } else if (sd_bus_error_has_name(error
, BUS_ERROR_TOKEN_USER_PRESENCE_NEEDED
)) {
457 log_notice("%s%sPlease confirm presence on security token.",
458 emoji_enabled() ? special_glyph(SPECIAL_GLYPH_TOUCH
) : "",
459 emoji_enabled() ? " " : "");
461 r
= user_record_set_fido2_user_presence_permitted(hr
, true);
463 return log_error_errno(r
, "Failed to set FIDO2 user presence permitted flag: %m");
465 } else if (sd_bus_error_has_name(error
, BUS_ERROR_TOKEN_USER_VERIFICATION_NEEDED
)) {
467 log_notice("%s%sPlease verify user on security token.",
468 emoji_enabled() ? special_glyph(SPECIAL_GLYPH_TOUCH
) : "",
469 emoji_enabled() ? " " : "");
471 r
= user_record_set_fido2_user_verification_permitted(hr
, true);
473 return log_error_errno(r
, "Failed to set FIDO2 user verification permitted flag: %m");
475 } else if (sd_bus_error_has_name(error
, BUS_ERROR_TOKEN_PIN_LOCKED
))
476 return log_error_errno(SYNTHETIC_ERRNO(EPERM
), "Security token PIN is locked, please unlock it first. (Hint: Removal and re-insertion might suffice.)");
478 else if (sd_bus_error_has_name(error
, BUS_ERROR_TOKEN_BAD_PIN
)) {
480 log_notice("Security token PIN incorrect, please try again.");
482 /* If the previous PIN was wrong don't accept cached info anymore, but add to cache. Also, don't use the credential data */
483 r
= acquire_token_pin(
486 ASK_PASSWORD_PUSH_CACHE
| ASK_PASSWORD_NO_CREDENTIAL
);
490 } else if (sd_bus_error_has_name(error
, BUS_ERROR_TOKEN_BAD_PIN_FEW_TRIES_LEFT
)) {
492 log_notice("Security token PIN incorrect, please try again (only a few tries left!).");
494 r
= acquire_token_pin(
497 ASK_PASSWORD_PUSH_CACHE
| ASK_PASSWORD_NO_CREDENTIAL
);
501 } else if (sd_bus_error_has_name(error
, BUS_ERROR_TOKEN_BAD_PIN_ONE_TRY_LEFT
)) {
503 log_notice("Security token PIN incorrect, please try again (only one try left!).");
505 r
= acquire_token_pin(
508 ASK_PASSWORD_PUSH_CACHE
| ASK_PASSWORD_NO_CREDENTIAL
);
512 return log_error_errno(ret
, "Operation on home %s failed: %s", user_name
, bus_error_message(error
, ret
));
517 static int acquire_passed_secrets(const char *user_name
, UserRecord
**ret
) {
518 _cleanup_(user_record_unrefp
) UserRecord
*secret
= NULL
;
523 /* Generates an initial secret objects that contains passwords supplied via $PASSWORD, the password
524 * cache or the credentials subsystem, but excluding any interactive stuff. If nothing is passed,
525 * returns an empty secret object. */
527 secret
= user_record_new();
531 r
= acquire_existing_password(
534 /* emphasize_current_password = */ false,
535 ASK_PASSWORD_ACCEPT_CACHED
| ASK_PASSWORD_NO_TTY
| ASK_PASSWORD_NO_AGENT
);
539 r
= acquire_token_pin(
542 ASK_PASSWORD_ACCEPT_CACHED
| ASK_PASSWORD_NO_TTY
| ASK_PASSWORD_NO_AGENT
);
546 r
= acquire_recovery_key(
549 ASK_PASSWORD_ACCEPT_CACHED
| ASK_PASSWORD_NO_TTY
| ASK_PASSWORD_NO_AGENT
);
553 *ret
= TAKE_PTR(secret
);
557 static int activate_home(int argc
, char *argv
[], void *userdata
) {
558 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
561 r
= acquire_bus(&bus
);
565 STRV_FOREACH(i
, strv_skip(argv
, 1)) {
566 _cleanup_(user_record_unrefp
) UserRecord
*secret
= NULL
;
568 r
= acquire_passed_secrets(*i
, &secret
);
573 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
574 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
576 r
= bus_message_new_method_call(bus
, &m
, bus_mgr
, "ActivateHome");
578 return bus_log_create_error(r
);
580 r
= sd_bus_message_append(m
, "s", *i
);
582 return bus_log_create_error(r
);
584 r
= bus_message_append_secret(m
, secret
);
586 return bus_log_create_error(r
);
588 r
= sd_bus_call(bus
, m
, HOME_SLOW_BUS_CALL_TIMEOUT_USEC
, &error
, NULL
);
590 r
= handle_generic_user_record_error(*i
, secret
, &error
, r
, /* emphasize_current_password= */ false);
605 static int deactivate_home(int argc
, char *argv
[], void *userdata
) {
606 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
609 r
= acquire_bus(&bus
);
613 STRV_FOREACH(i
, strv_skip(argv
, 1)) {
614 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
615 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
617 r
= bus_message_new_method_call(bus
, &m
, bus_mgr
, "DeactivateHome");
619 return bus_log_create_error(r
);
621 r
= sd_bus_message_append(m
, "s", *i
);
623 return bus_log_create_error(r
);
625 r
= sd_bus_call(bus
, m
, HOME_SLOW_BUS_CALL_TIMEOUT_USEC
, &error
, NULL
);
627 log_error_errno(r
, "Failed to deactivate user home: %s", bus_error_message(&error
, r
));
636 static void dump_home_record(UserRecord
*hr
) {
641 if (hr
->incomplete
) {
643 log_warning("Warning: lacking rights to acquire privileged fields of user record of '%s', output incomplete.", hr
->user_name
);
646 if (arg_json_format_flags
& JSON_FORMAT_OFF
)
647 user_record_show(hr
, true);
649 _cleanup_(user_record_unrefp
) UserRecord
*stripped
= NULL
;
651 if (arg_export_format
== EXPORT_FORMAT_STRIPPED
)
652 r
= user_record_clone(hr
, USER_RECORD_EXTRACT_EMBEDDED
|USER_RECORD_PERMISSIVE
, &stripped
);
653 else if (arg_export_format
== EXPORT_FORMAT_MINIMAL
)
654 r
= user_record_clone(hr
, USER_RECORD_EXTRACT_SIGNABLE
|USER_RECORD_PERMISSIVE
, &stripped
);
658 log_warning_errno(r
, "Failed to strip user record, ignoring: %m");
662 json_variant_dump(hr
->json
, arg_json_format_flags
, stdout
, NULL
);
666 static char **mangle_user_list(char **list
, char ***ret_allocated
) {
667 _cleanup_free_
char *myself
= NULL
;
670 if (!strv_isempty(list
)) {
671 *ret_allocated
= NULL
;
675 myself
= getusername_malloc();
683 l
[0] = TAKE_PTR(myself
);
690 static int inspect_home(int argc
, char *argv
[], void *userdata
) {
691 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
692 _cleanup_(strv_freep
) char **mangled_list
= NULL
;
696 pager_open(arg_pager_flags
);
698 r
= acquire_bus(&bus
);
702 items
= mangle_user_list(strv_skip(argv
, 1), &mangled_list
);
706 STRV_FOREACH(i
, items
) {
707 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
708 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
709 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
710 _cleanup_(user_record_unrefp
) UserRecord
*hr
= NULL
;
715 r
= parse_uid(*i
, &uid
);
717 if (!valid_user_group_name(*i
, 0)) {
718 log_error("Invalid user name '%s'.", *i
);
725 r
= bus_call_method(bus
, bus_mgr
, "GetUserRecordByName", &error
, &reply
, "s", *i
);
727 r
= bus_call_method(bus
, bus_mgr
, "GetUserRecordByUID", &error
, &reply
, "u", (uint32_t) uid
);
730 log_error_errno(r
, "Failed to inspect home: %s", bus_error_message(&error
, r
));
737 r
= sd_bus_message_read(reply
, "sbo", &json
, &incomplete
, NULL
);
739 bus_log_parse_error(r
);
746 r
= json_parse(json
, JSON_PARSE_SENSITIVE
, &v
, NULL
, NULL
);
748 log_error_errno(r
, "Failed to parse JSON identity: %m");
755 hr
= user_record_new();
759 r
= user_record_load(hr
, v
, USER_RECORD_LOAD_REFUSE_SECRET
|USER_RECORD_LOG
|USER_RECORD_PERMISSIVE
);
767 hr
->incomplete
= incomplete
;
768 dump_home_record(hr
);
774 static int authenticate_home(int argc
, char *argv
[], void *userdata
) {
775 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
776 _cleanup_(strv_freep
) char **mangled_list
= NULL
;
780 items
= mangle_user_list(strv_skip(argv
, 1), &mangled_list
);
784 r
= acquire_bus(&bus
);
788 (void) polkit_agent_open_if_enabled(arg_transport
, arg_ask_password
);
790 STRV_FOREACH(i
, items
) {
791 _cleanup_(user_record_unrefp
) UserRecord
*secret
= NULL
;
793 r
= acquire_passed_secrets(*i
, &secret
);
798 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
799 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
801 r
= bus_message_new_method_call(bus
, &m
, bus_mgr
, "AuthenticateHome");
803 return bus_log_create_error(r
);
805 r
= sd_bus_message_append(m
, "s", *i
);
807 return bus_log_create_error(r
);
809 r
= bus_message_append_secret(m
, secret
);
811 return bus_log_create_error(r
);
813 r
= sd_bus_call(bus
, m
, HOME_SLOW_BUS_CALL_TIMEOUT_USEC
, &error
, NULL
);
815 r
= handle_generic_user_record_error(*i
, secret
, &error
, r
, false);
830 static int update_last_change(JsonVariant
**v
, bool with_password
, bool override
) {
837 n
= now(CLOCK_REALTIME
);
839 c
= json_variant_by_key(*v
, "lastChangeUSec");
844 goto update_password
;
846 if (!json_variant_is_unsigned(c
))
847 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "lastChangeUSec field is not an unsigned integer, refusing.");
849 u
= json_variant_unsigned(c
);
851 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "lastChangeUSec is from the future, can't update.");
854 r
= json_variant_set_field_unsigned(v
, "lastChangeUSec", n
);
856 return log_error_errno(r
, "Failed to update lastChangeUSec: %m");
862 c
= json_variant_by_key(*v
, "lastPasswordChangeUSec");
869 if (!json_variant_is_unsigned(c
))
870 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "lastPasswordChangeUSec field is not an unsigned integer, refusing.");
872 u
= json_variant_unsigned(c
);
874 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "lastPasswordChangeUSec is from the future, can't update.");
877 r
= json_variant_set_field_unsigned(v
, "lastPasswordChangeUSec", n
);
879 return log_error_errno(r
, "Failed to update lastPasswordChangeUSec: %m");
884 static int apply_identity_changes(JsonVariant
**_v
) {
885 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
890 v
= json_variant_ref(*_v
);
892 r
= json_variant_filter(&v
, arg_identity_filter
);
894 return log_error_errno(r
, "Failed to filter identity: %m");
896 r
= json_variant_merge(&v
, arg_identity_extra
);
898 return log_error_errno(r
, "Failed to merge identities: %m");
900 if (arg_identity_extra_this_machine
|| !strv_isempty(arg_identity_filter
)) {
901 _cleanup_(json_variant_unrefp
) JsonVariant
*per_machine
= NULL
, *mmid
= NULL
;
904 r
= sd_id128_get_machine(&mid
);
906 return log_error_errno(r
, "Failed to acquire machine ID: %m");
908 r
= json_variant_new_string(&mmid
, SD_ID128_TO_STRING(mid
));
910 return log_error_errno(r
, "Failed to allocate matchMachineId object: %m");
912 per_machine
= json_variant_ref(json_variant_by_key(v
, "perMachine"));
914 _cleanup_(json_variant_unrefp
) JsonVariant
*npm
= NULL
, *add
= NULL
;
915 _cleanup_free_ JsonVariant
**array
= NULL
;
919 if (!json_variant_is_array(per_machine
))
920 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "perMachine field is not an array, refusing.");
922 array
= new(JsonVariant
*, json_variant_elements(per_machine
) + 1);
926 JSON_VARIANT_ARRAY_FOREACH(z
, per_machine
) {
929 if (!json_variant_is_object(z
))
930 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "perMachine entry is not an object, refusing.");
934 u
= json_variant_by_key(z
, "matchMachineId");
938 if (!json_variant_equal(u
, mmid
))
941 r
= json_variant_merge(&add
, z
);
943 return log_error_errno(r
, "Failed to merge perMachine entry: %m");
948 r
= json_variant_filter(&add
, arg_identity_filter
);
950 return log_error_errno(r
, "Failed to filter perMachine: %m");
952 r
= json_variant_merge(&add
, arg_identity_extra_this_machine
);
954 return log_error_errno(r
, "Failed to merge in perMachine fields: %m");
956 if (arg_identity_filter_rlimits
|| arg_identity_extra_rlimits
) {
957 _cleanup_(json_variant_unrefp
) JsonVariant
*rlv
= NULL
;
959 rlv
= json_variant_ref(json_variant_by_key(add
, "resourceLimits"));
961 r
= json_variant_filter(&rlv
, arg_identity_filter_rlimits
);
963 return log_error_errno(r
, "Failed to filter resource limits: %m");
965 r
= json_variant_merge(&rlv
, arg_identity_extra_rlimits
);
967 return log_error_errno(r
, "Failed to set resource limits: %m");
969 if (json_variant_is_blank_object(rlv
)) {
970 r
= json_variant_filter(&add
, STRV_MAKE("resourceLimits"));
972 return log_error_errno(r
, "Failed to drop resource limits field from identity: %m");
974 r
= json_variant_set_field(&add
, "resourceLimits", rlv
);
976 return log_error_errno(r
, "Failed to update resource limits of identity: %m");
980 if (!json_variant_is_blank_object(add
)) {
981 r
= json_variant_set_field(&add
, "matchMachineId", mmid
);
983 return log_error_errno(r
, "Failed to set matchMachineId field: %m");
988 r
= json_variant_new_array(&npm
, array
, i
);
990 return log_error_errno(r
, "Failed to allocate new perMachine array: %m");
992 json_variant_unref(per_machine
);
993 per_machine
= TAKE_PTR(npm
);
995 _cleanup_(json_variant_unrefp
) JsonVariant
*item
= json_variant_ref(arg_identity_extra_this_machine
);
997 if (arg_identity_extra_rlimits
) {
998 r
= json_variant_set_field(&item
, "resourceLimits", arg_identity_extra_rlimits
);
1000 return log_error_errno(r
, "Failed to update resource limits of identity: %m");
1003 r
= json_variant_set_field(&item
, "matchMachineId", mmid
);
1005 return log_error_errno(r
, "Failed to set matchMachineId field: %m");
1007 r
= json_variant_append_array(&per_machine
, item
);
1009 return log_error_errno(r
, "Failed to append to perMachine array: %m");
1012 r
= json_variant_set_field(&v
, "perMachine", per_machine
);
1014 return log_error_errno(r
, "Failed to update per machine record: %m");
1017 if (arg_identity_extra_privileged
|| arg_identity_filter
) {
1018 _cleanup_(json_variant_unrefp
) JsonVariant
*privileged
= NULL
;
1020 privileged
= json_variant_ref(json_variant_by_key(v
, "privileged"));
1022 r
= json_variant_filter(&privileged
, arg_identity_filter
);
1024 return log_error_errno(r
, "Failed to filter identity (privileged part): %m");
1026 r
= json_variant_merge(&privileged
, arg_identity_extra_privileged
);
1028 return log_error_errno(r
, "Failed to merge identities (privileged part): %m");
1030 if (json_variant_is_blank_object(privileged
)) {
1031 r
= json_variant_filter(&v
, STRV_MAKE("privileged"));
1033 return log_error_errno(r
, "Failed to drop privileged part from identity: %m");
1035 r
= json_variant_set_field(&v
, "privileged", privileged
);
1037 return log_error_errno(r
, "Failed to update privileged part of identity: %m");
1041 if (arg_identity_filter_rlimits
) {
1042 _cleanup_(json_variant_unrefp
) JsonVariant
*rlv
= NULL
;
1044 rlv
= json_variant_ref(json_variant_by_key(v
, "resourceLimits"));
1046 r
= json_variant_filter(&rlv
, arg_identity_filter_rlimits
);
1048 return log_error_errno(r
, "Failed to filter resource limits: %m");
1050 /* Note that we only filter resource limits here, but don't apply them. We do that in the perMachine section */
1052 if (json_variant_is_blank_object(rlv
)) {
1053 r
= json_variant_filter(&v
, STRV_MAKE("resourceLimits"));
1055 return log_error_errno(r
, "Failed to drop resource limits field from identity: %m");
1057 r
= json_variant_set_field(&v
, "resourceLimits", rlv
);
1059 return log_error_errno(r
, "Failed to update resource limits of identity: %m");
1063 json_variant_unref(*_v
);
1069 static int add_disposition(JsonVariant
**v
) {
1074 if (json_variant_by_key(*v
, "disposition"))
1077 /* Set the disposition to regular, if not configured explicitly */
1078 r
= json_variant_set_field_string(v
, "disposition", "regular");
1080 return log_error_errno(r
, "Failed to set disposition field: %m");
1085 static int acquire_new_home_record(UserRecord
**ret
) {
1086 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
1087 _cleanup_(user_record_unrefp
) UserRecord
*hr
= NULL
;
1093 unsigned line
, column
;
1095 r
= json_parse_file(
1096 streq(arg_identity
, "-") ? stdin
: NULL
,
1097 streq(arg_identity
, "-") ? "<stdin>" : arg_identity
, JSON_PARSE_SENSITIVE
, &v
, &line
, &column
);
1099 return log_error_errno(r
, "Failed to parse identity at %u:%u: %m", line
, column
);
1102 r
= apply_identity_changes(&v
);
1106 r
= add_disposition(&v
);
1110 STRV_FOREACH(i
, arg_pkcs11_token_uri
) {
1111 r
= identity_add_pkcs11_key_data(&v
, *i
);
1116 STRV_FOREACH(i
, arg_fido2_device
) {
1117 r
= identity_add_fido2_parameters(&v
, *i
, arg_fido2_lock_with
);
1122 if (arg_recovery_key
) {
1123 r
= identity_add_recovery_key(&v
);
1128 r
= update_last_change(&v
, true, false);
1133 json_variant_dump(v
, JSON_FORMAT_PRETTY
, NULL
, NULL
);
1135 hr
= user_record_new();
1139 r
= user_record_load(hr
, v
, USER_RECORD_REQUIRE_REGULAR
|USER_RECORD_ALLOW_SECRET
|USER_RECORD_ALLOW_PRIVILEGED
|USER_RECORD_ALLOW_PER_MACHINE
|USER_RECORD_ALLOW_SIGNATURE
|USER_RECORD_LOG
|USER_RECORD_PERMISSIVE
);
1143 *ret
= TAKE_PTR(hr
);
1147 static int acquire_new_password(
1148 const char *user_name
,
1153 _cleanup_(erase_and_freep
) char *envpw
= NULL
;
1160 r
= getenv_steal_erase("NEWPASSWORD", &envpw
);
1162 return log_error_errno(r
, "Failed to acquire password from environment: %m");
1164 /* As above, this is not for use, just for testing */
1166 r
= user_record_set_password(hr
, STRV_MAKE(envpw
), /* prepend = */ true);
1168 return log_error_errno(r
, "Failed to store password: %m");
1171 *ret
= TAKE_PTR(envpw
);
1177 (void) suggest_passwords();
1180 _cleanup_(strv_free_erasep
) char **first
= NULL
, **second
= NULL
;
1181 _cleanup_free_
char *question
= NULL
;
1184 return log_error_errno(SYNTHETIC_ERRNO(ENOKEY
), "Too many attempts, giving up:");
1186 if (asprintf(&question
, "Please enter new password for user %s:", user_name
) < 0)
1189 r
= ask_password_auto(
1191 /* icon= */ "user-home",
1193 /* key_name= */ "home-password",
1194 /* credential_name= */ "home.new-password",
1196 0, /* no caching, we want to collect a new password here after all */
1199 return log_error_errno(r
, "Failed to acquire password: %m");
1201 question
= mfree(question
);
1202 if (asprintf(&question
, "Please enter new password for user %s (repeat):", user_name
) < 0)
1205 r
= ask_password_auto(
1207 /* icon= */ "user-home",
1209 /* key_name= */ "home-password",
1210 /* credential_name= */ "home.new-password",
1215 return log_error_errno(r
, "Failed to acquire password: %m");
1217 if (strv_equal(first
, second
)) {
1218 _cleanup_(erase_and_freep
) char *copy
= NULL
;
1221 copy
= strdup(first
[0]);
1226 r
= user_record_set_password(hr
, first
, /* prepend = */ true);
1228 return log_error_errno(r
, "Failed to store password: %m");
1231 *ret
= TAKE_PTR(copy
);
1236 log_error("Password didn't match, try again.");
1240 static int create_home(int argc
, char *argv
[], void *userdata
) {
1241 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
1242 _cleanup_(user_record_unrefp
) UserRecord
*hr
= NULL
;
1245 r
= acquire_bus(&bus
);
1249 (void) polkit_agent_open_if_enabled(arg_transport
, arg_ask_password
);
1252 /* If a username was specified, use it */
1254 if (valid_user_group_name(argv
[1], 0))
1255 r
= json_variant_set_field_string(&arg_identity_extra
, "userName", argv
[1]);
1257 _cleanup_free_
char *un
= NULL
, *rr
= NULL
;
1259 /* Before we consider the user name invalid, let's check if we can split it? */
1260 r
= split_user_name_realm(argv
[1], &un
, &rr
);
1262 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "User name '%s' is not valid: %m", argv
[1]);
1265 r
= json_variant_set_field_string(&arg_identity_extra
, "realm", rr
);
1267 return log_error_errno(r
, "Failed to set realm field: %m");
1270 r
= json_variant_set_field_string(&arg_identity_extra
, "userName", un
);
1273 return log_error_errno(r
, "Failed to set userName field: %m");
1275 /* If neither a username nor an identity have been specified we cannot operate. */
1277 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "User name required.");
1280 r
= acquire_new_home_record(&hr
);
1284 /* If the JSON record carries no plain text password (besides the recovery key), then let's query it
1286 if (strv_length(hr
->password
) <= arg_recovery_key
) {
1288 if (strv_isempty(hr
->hashed_password
)) {
1289 _cleanup_(erase_and_freep
) char *new_password
= NULL
;
1291 /* No regular (i.e. non-PKCS#11) hashed passwords set in the record, let's fix that. */
1292 r
= acquire_new_password(hr
->user_name
, hr
, /* suggest = */ true, &new_password
);
1296 r
= user_record_make_hashed_password(hr
, STRV_MAKE(new_password
), /* extend = */ false);
1298 return log_error_errno(r
, "Failed to hash password: %m");
1300 /* There's a hash password set in the record, acquire the unhashed version of it. */
1301 r
= acquire_existing_password(
1304 /* emphasize_current= */ false,
1305 ASK_PASSWORD_ACCEPT_CACHED
| ASK_PASSWORD_PUSH_CACHE
);
1311 if (hr
->enforce_password_policy
== 0) {
1312 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1314 /* If password quality enforcement is disabled, let's at least warn client side */
1316 r
= user_record_quality_check_password(hr
, hr
, &error
);
1318 log_warning_errno(r
, "Specified password does not pass quality checks (%s), proceeding anyway.", bus_error_message(&error
, r
));
1322 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1323 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
1324 _cleanup_(erase_and_freep
) char *formatted
= NULL
;
1326 r
= json_variant_format(hr
->json
, 0, &formatted
);
1328 return log_error_errno(r
, "Failed to format user record: %m");
1330 r
= bus_message_new_method_call(bus
, &m
, bus_mgr
, "CreateHome");
1332 return bus_log_create_error(r
);
1334 (void) sd_bus_message_sensitive(m
);
1336 r
= sd_bus_message_append(m
, "s", formatted
);
1338 return bus_log_create_error(r
);
1340 r
= sd_bus_call(bus
, m
, HOME_SLOW_BUS_CALL_TIMEOUT_USEC
, &error
, NULL
);
1342 if (sd_bus_error_has_name(&error
, BUS_ERROR_LOW_PASSWORD_QUALITY
)) {
1343 _cleanup_(erase_and_freep
) char *new_password
= NULL
;
1345 log_error_errno(r
, "%s", bus_error_message(&error
, r
));
1346 log_info("(Use --enforce-password-policy=no to turn off password quality checks for this account.)");
1348 r
= acquire_new_password(hr
->user_name
, hr
, /* suggest = */ false, &new_password
);
1352 r
= user_record_make_hashed_password(hr
, STRV_MAKE(new_password
), /* extend = */ false);
1354 return log_error_errno(r
, "Failed to hash passwords: %m");
1356 r
= handle_generic_user_record_error(hr
->user_name
, hr
, &error
, r
, false);
1367 static int remove_home(int argc
, char *argv
[], void *userdata
) {
1368 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
1371 r
= acquire_bus(&bus
);
1375 (void) polkit_agent_open_if_enabled(arg_transport
, arg_ask_password
);
1377 STRV_FOREACH(i
, strv_skip(argv
, 1)) {
1378 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1379 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
1381 r
= bus_message_new_method_call(bus
, &m
, bus_mgr
, "RemoveHome");
1383 return bus_log_create_error(r
);
1385 r
= sd_bus_message_append(m
, "s", *i
);
1387 return bus_log_create_error(r
);
1389 r
= sd_bus_call(bus
, m
, HOME_SLOW_BUS_CALL_TIMEOUT_USEC
, &error
, NULL
);
1391 log_error_errno(r
, "Failed to remove home: %s", bus_error_message(&error
, r
));
1400 static int acquire_updated_home_record(
1402 const char *username
,
1405 _cleanup_(json_variant_unrefp
) JsonVariant
*json
= NULL
;
1406 _cleanup_(user_record_unrefp
) UserRecord
*hr
= NULL
;
1412 unsigned line
, column
;
1415 r
= json_parse_file(
1416 streq(arg_identity
, "-") ? stdin
: NULL
,
1417 streq(arg_identity
, "-") ? "<stdin>" : arg_identity
, JSON_PARSE_SENSITIVE
, &json
, &line
, &column
);
1419 return log_error_errno(r
, "Failed to parse identity at %u:%u: %m", line
, column
);
1421 un
= json_variant_by_key(json
, "userName");
1423 if (!json_variant_is_string(un
) || (username
&& !streq(json_variant_string(un
), username
)))
1424 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "User name specified on command line and in JSON record do not match.");
1427 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "No username specified.");
1429 r
= json_variant_set_field_string(&arg_identity_extra
, "userName", username
);
1431 return log_error_errno(r
, "Failed to set userName field: %m");
1435 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1436 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
1440 if (!identity_properties_specified())
1441 return log_error_errno(SYNTHETIC_ERRNO(EALREADY
), "No field to change specified.");
1443 r
= bus_call_method(bus
, bus_mgr
, "GetUserRecordByName", &error
, &reply
, "s", username
);
1445 return log_error_errno(r
, "Failed to acquire user home record: %s", bus_error_message(&error
, r
));
1447 r
= sd_bus_message_read(reply
, "sbo", &text
, &incomplete
, NULL
);
1449 return bus_log_parse_error(r
);
1452 return log_error_errno(SYNTHETIC_ERRNO(EACCES
), "Lacking rights to acquire user record including privileged metadata, can't update record.");
1454 r
= json_parse(text
, JSON_PARSE_SENSITIVE
, &json
, NULL
, NULL
);
1456 return log_error_errno(r
, "Failed to parse JSON identity: %m");
1458 reply
= sd_bus_message_unref(reply
);
1460 r
= json_variant_filter(&json
, STRV_MAKE("binding", "status", "signature"));
1462 return log_error_errno(r
, "Failed to strip binding and status from record to update: %m");
1465 r
= apply_identity_changes(&json
);
1469 STRV_FOREACH(i
, arg_pkcs11_token_uri
) {
1470 r
= identity_add_pkcs11_key_data(&json
, *i
);
1475 STRV_FOREACH(i
, arg_fido2_device
) {
1476 r
= identity_add_fido2_parameters(&json
, *i
, arg_fido2_lock_with
);
1481 /* If the user supplied a full record, then add in lastChange, but do not override. Otherwise always
1483 r
= update_last_change(&json
, arg_pkcs11_token_uri
|| arg_fido2_device
, !arg_identity
);
1488 json_variant_dump(json
, JSON_FORMAT_PRETTY
, NULL
, NULL
);
1490 hr
= user_record_new();
1494 r
= user_record_load(hr
, json
, USER_RECORD_REQUIRE_REGULAR
|USER_RECORD_ALLOW_PRIVILEGED
|USER_RECORD_ALLOW_PER_MACHINE
|USER_RECORD_ALLOW_SECRET
|USER_RECORD_ALLOW_SIGNATURE
|USER_RECORD_LOG
|USER_RECORD_PERMISSIVE
);
1498 *ret
= TAKE_PTR(hr
);
1502 static int home_record_reset_human_interaction_permission(UserRecord
*hr
) {
1507 /* When we execute multiple operations one after the other, let's reset the permission to ask the
1508 * user each time, so that if interaction is necessary we will be told so again and thus can print a
1509 * nice message to the user, telling the user so. */
1511 r
= user_record_set_pkcs11_protected_authentication_path_permitted(hr
, -1);
1513 return log_error_errno(r
, "Failed to reset PKCS#11 protected authentication path permission flag: %m");
1515 r
= user_record_set_fido2_user_presence_permitted(hr
, -1);
1517 return log_error_errno(r
, "Failed to reset FIDO2 user presence permission flag: %m");
1519 r
= user_record_set_fido2_user_verification_permitted(hr
, -1);
1521 return log_error_errno(r
, "Failed to reset FIDO2 user verification permission flag: %m");
1526 static int update_home(int argc
, char *argv
[], void *userdata
) {
1527 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
1528 _cleanup_(user_record_unrefp
) UserRecord
*hr
= NULL
, *secret
= NULL
;
1529 _cleanup_free_
char *buffer
= NULL
;
1530 const char *username
;
1535 else if (!arg_identity
) {
1536 buffer
= getusername_malloc();
1544 r
= acquire_bus(&bus
);
1548 (void) polkit_agent_open_if_enabled(arg_transport
, arg_ask_password
);
1550 r
= acquire_updated_home_record(bus
, username
, &hr
);
1554 /* Add in all secrets we can acquire cheaply */
1555 r
= acquire_passed_secrets(username
, &secret
);
1559 r
= user_record_merge_secret(hr
, secret
);
1563 /* If we do multiple operations, let's output things more verbosely, since otherwise the repeated
1564 * authentication might be confusing. */
1566 if (arg_and_resize
|| arg_and_change_password
)
1567 log_info("Updating home directory.");
1570 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1571 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
1572 _cleanup_free_
char *formatted
= NULL
;
1574 r
= bus_message_new_method_call(bus
, &m
, bus_mgr
, "UpdateHome");
1576 return bus_log_create_error(r
);
1578 r
= json_variant_format(hr
->json
, 0, &formatted
);
1580 return log_error_errno(r
, "Failed to format user record: %m");
1582 (void) sd_bus_message_sensitive(m
);
1584 r
= sd_bus_message_append(m
, "s", formatted
);
1586 return bus_log_create_error(r
);
1588 r
= sd_bus_call(bus
, m
, HOME_SLOW_BUS_CALL_TIMEOUT_USEC
, &error
, NULL
);
1590 if (arg_and_change_password
&&
1591 sd_bus_error_has_name(&error
, BUS_ERROR_BAD_PASSWORD_AND_NO_TOKEN
))
1592 /* In the generic handler we'd ask for a password in this case, but when
1593 * changing passwords that's not sufficient, as we need to acquire all keys
1595 return log_error_errno(r
, "Security token not inserted, refusing.");
1597 r
= handle_generic_user_record_error(hr
->user_name
, hr
, &error
, r
, false);
1605 log_info("Resizing home.");
1607 (void) home_record_reset_human_interaction_permission(hr
);
1609 /* Also sync down disk size to underlying LUKS/fscrypt/quota */
1610 while (arg_and_resize
) {
1611 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1612 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
1614 r
= bus_message_new_method_call(bus
, &m
, bus_mgr
, "ResizeHome");
1616 return bus_log_create_error(r
);
1618 /* Specify UINT64_MAX as size, in which case the underlying disk size will just be synced */
1619 r
= sd_bus_message_append(m
, "st", hr
->user_name
, UINT64_MAX
);
1621 return bus_log_create_error(r
);
1623 r
= bus_message_append_secret(m
, hr
);
1625 return bus_log_create_error(r
);
1627 r
= sd_bus_call(bus
, m
, HOME_SLOW_BUS_CALL_TIMEOUT_USEC
, &error
, NULL
);
1629 if (arg_and_change_password
&&
1630 sd_bus_error_has_name(&error
, BUS_ERROR_BAD_PASSWORD_AND_NO_TOKEN
))
1631 return log_error_errno(r
, "Security token not inserted, refusing.");
1633 r
= handle_generic_user_record_error(hr
->user_name
, hr
, &error
, r
, false);
1640 if (arg_and_change_password
)
1641 log_info("Synchronizing passwords and encryption keys.");
1643 (void) home_record_reset_human_interaction_permission(hr
);
1645 /* Also sync down passwords to underlying LUKS/fscrypt */
1646 while (arg_and_change_password
) {
1647 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1648 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
1650 r
= bus_message_new_method_call(bus
, &m
, bus_mgr
, "ChangePasswordHome");
1652 return bus_log_create_error(r
);
1654 /* Specify an empty new secret, in which case the underlying LUKS/fscrypt password will just be synced */
1655 r
= sd_bus_message_append(m
, "ss", hr
->user_name
, "{}");
1657 return bus_log_create_error(r
);
1659 r
= bus_message_append_secret(m
, hr
);
1661 return bus_log_create_error(r
);
1663 r
= sd_bus_call(bus
, m
, HOME_SLOW_BUS_CALL_TIMEOUT_USEC
, &error
, NULL
);
1665 if (sd_bus_error_has_name(&error
, BUS_ERROR_BAD_PASSWORD_AND_NO_TOKEN
))
1666 return log_error_errno(r
, "Security token not inserted, refusing.");
1668 r
= handle_generic_user_record_error(hr
->user_name
, hr
, &error
, r
, false);
1678 static int passwd_home(int argc
, char *argv
[], void *userdata
) {
1679 _cleanup_(user_record_unrefp
) UserRecord
*old_secret
= NULL
, *new_secret
= NULL
;
1680 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
1681 _cleanup_free_
char *buffer
= NULL
;
1682 const char *username
;
1685 if (arg_pkcs11_token_uri
)
1686 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "To change the PKCS#11 security token use 'homectl update --pkcs11-token-uri=…'.");
1687 if (arg_fido2_device
)
1688 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "To change the FIDO2 security token use 'homectl update --fido2-device=…'.");
1689 if (identity_properties_specified())
1690 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "The 'passwd' verb does not permit changing other record properties at the same time.");
1695 buffer
= getusername_malloc();
1702 r
= acquire_bus(&bus
);
1706 (void) polkit_agent_open_if_enabled(arg_transport
, arg_ask_password
);
1708 r
= acquire_passed_secrets(username
, &old_secret
);
1712 new_secret
= user_record_new();
1716 r
= acquire_new_password(username
, new_secret
, /* suggest = */ true, NULL
);
1721 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1722 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
1724 r
= bus_message_new_method_call(bus
, &m
, bus_mgr
, "ChangePasswordHome");
1726 return bus_log_create_error(r
);
1728 r
= sd_bus_message_append(m
, "s", username
);
1730 return bus_log_create_error(r
);
1732 r
= bus_message_append_secret(m
, new_secret
);
1734 return bus_log_create_error(r
);
1736 r
= bus_message_append_secret(m
, old_secret
);
1738 return bus_log_create_error(r
);
1740 r
= sd_bus_call(bus
, m
, HOME_SLOW_BUS_CALL_TIMEOUT_USEC
, &error
, NULL
);
1742 if (sd_bus_error_has_name(&error
, BUS_ERROR_LOW_PASSWORD_QUALITY
)) {
1744 log_error_errno(r
, "%s", bus_error_message(&error
, r
));
1746 r
= acquire_new_password(username
, new_secret
, /* suggest = */ false, NULL
);
1748 } else if (sd_bus_error_has_name(&error
, BUS_ERROR_BAD_PASSWORD_AND_NO_TOKEN
))
1750 /* In the generic handler we'd ask for a password in this case, but when
1751 * changing passwords that's not sufficeint, as we need to acquire all keys
1753 return log_error_errno(r
, "Security token not inserted, refusing.");
1755 r
= handle_generic_user_record_error(username
, old_secret
, &error
, r
, true);
1765 static int parse_disk_size(const char *t
, uint64_t *ret
) {
1771 if (streq(t
, "min"))
1773 else if (streq(t
, "max"))
1774 *ret
= UINT64_MAX
-1; /* Largest size that isn't UINT64_MAX special marker */
1778 r
= parse_size(t
, 1024, &ds
);
1780 return log_error_errno(r
, "Failed to parse disk size parameter: %s", t
);
1782 if (ds
>= UINT64_MAX
) /* UINT64_MAX has special meaning for us ("dont change"), refuse */
1783 return log_error_errno(SYNTHETIC_ERRNO(ERANGE
), "Disk size out of range: %s", t
);
1791 static int resize_home(int argc
, char *argv
[], void *userdata
) {
1792 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
1793 _cleanup_(user_record_unrefp
) UserRecord
*secret
= NULL
;
1794 uint64_t ds
= UINT64_MAX
;
1797 r
= acquire_bus(&bus
);
1801 (void) polkit_agent_open_if_enabled(arg_transport
, arg_ask_password
);
1803 if (arg_disk_size_relative
!= UINT64_MAX
||
1804 (argc
> 2 && parse_permyriad(argv
[2]) >= 0))
1805 return log_error_errno(SYNTHETIC_ERRNO(EOPNOTSUPP
),
1806 "Relative disk size specification currently not supported when resizing.");
1809 r
= parse_disk_size(argv
[2], &ds
);
1814 if (arg_disk_size
!= UINT64_MAX
) {
1815 if (ds
!= UINT64_MAX
&& ds
!= arg_disk_size
)
1816 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Disk size specified twice and doesn't match, refusing.");
1821 r
= acquire_passed_secrets(argv
[1], &secret
);
1826 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1827 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
1829 r
= bus_message_new_method_call(bus
, &m
, bus_mgr
, "ResizeHome");
1831 return bus_log_create_error(r
);
1833 r
= sd_bus_message_append(m
, "st", argv
[1], ds
);
1835 return bus_log_create_error(r
);
1837 r
= bus_message_append_secret(m
, secret
);
1839 return bus_log_create_error(r
);
1841 r
= sd_bus_call(bus
, m
, HOME_SLOW_BUS_CALL_TIMEOUT_USEC
, &error
, NULL
);
1843 r
= handle_generic_user_record_error(argv
[1], secret
, &error
, r
, false);
1853 static int lock_home(int argc
, char *argv
[], void *userdata
) {
1854 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
1857 r
= acquire_bus(&bus
);
1861 STRV_FOREACH(i
, strv_skip(argv
, 1)) {
1862 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1863 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
1865 r
= bus_message_new_method_call(bus
, &m
, bus_mgr
, "LockHome");
1867 return bus_log_create_error(r
);
1869 r
= sd_bus_message_append(m
, "s", *i
);
1871 return bus_log_create_error(r
);
1873 r
= sd_bus_call(bus
, m
, HOME_SLOW_BUS_CALL_TIMEOUT_USEC
, &error
, NULL
);
1875 log_error_errno(r
, "Failed to lock home: %s", bus_error_message(&error
, r
));
1884 static int unlock_home(int argc
, char *argv
[], void *userdata
) {
1885 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
1888 r
= acquire_bus(&bus
);
1892 STRV_FOREACH(i
, strv_skip(argv
, 1)) {
1893 _cleanup_(user_record_unrefp
) UserRecord
*secret
= NULL
;
1895 r
= acquire_passed_secrets(*i
, &secret
);
1900 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1901 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
1903 r
= bus_message_new_method_call(bus
, &m
, bus_mgr
, "UnlockHome");
1905 return bus_log_create_error(r
);
1907 r
= sd_bus_message_append(m
, "s", *i
);
1909 return bus_log_create_error(r
);
1911 r
= bus_message_append_secret(m
, secret
);
1913 return bus_log_create_error(r
);
1915 r
= sd_bus_call(bus
, m
, HOME_SLOW_BUS_CALL_TIMEOUT_USEC
, &error
, NULL
);
1917 r
= handle_generic_user_record_error(argv
[1], secret
, &error
, r
, false);
1932 static int with_home(int argc
, char *argv
[], void *userdata
) {
1933 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1934 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
, *reply
= NULL
;
1935 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
1936 _cleanup_(user_record_unrefp
) UserRecord
*secret
= NULL
;
1937 _cleanup_close_
int acquired_fd
= -1;
1938 _cleanup_strv_free_
char **cmdline
= NULL
;
1943 r
= acquire_bus(&bus
);
1948 _cleanup_free_
char *shell
= NULL
;
1950 /* If no command is specified, spawn a shell */
1951 r
= get_shell(&shell
);
1953 return log_error_errno(r
, "Failed to acquire shell: %m");
1955 cmdline
= strv_new(shell
);
1957 cmdline
= strv_copy(argv
+ 2);
1961 r
= acquire_passed_secrets(argv
[1], &secret
);
1966 r
= bus_message_new_method_call(bus
, &m
, bus_mgr
, "AcquireHome");
1968 return bus_log_create_error(r
);
1970 r
= sd_bus_message_append(m
, "s", argv
[1]);
1972 return bus_log_create_error(r
);
1974 r
= bus_message_append_secret(m
, secret
);
1976 return bus_log_create_error(r
);
1978 r
= sd_bus_message_append(m
, "b", /* please_suspend = */ getenv_bool("SYSTEMD_PLEASE_SUSPEND_HOME") > 0);
1980 return bus_log_create_error(r
);
1982 r
= sd_bus_call(bus
, m
, HOME_SLOW_BUS_CALL_TIMEOUT_USEC
, &error
, &reply
);
1983 m
= sd_bus_message_unref(m
);
1985 r
= handle_generic_user_record_error(argv
[1], secret
, &error
, r
, false);
1989 sd_bus_error_free(&error
);
1993 r
= sd_bus_message_read(reply
, "h", &fd
);
1995 return bus_log_parse_error(r
);
1997 acquired_fd
= fcntl(fd
, F_DUPFD_CLOEXEC
, 3);
1998 if (acquired_fd
< 0)
1999 return log_error_errno(errno
, "Failed to duplicate acquired fd: %m");
2001 reply
= sd_bus_message_unref(reply
);
2006 r
= bus_call_method(bus
, bus_mgr
, "GetHomeByName", &error
, &reply
, "s", argv
[1]);
2008 return log_error_errno(r
, "Failed to inspect home: %s", bus_error_message(&error
, r
));
2010 r
= sd_bus_message_read(reply
, "usussso", NULL
, NULL
, NULL
, NULL
, &home
, NULL
, NULL
);
2012 return bus_log_parse_error(r
);
2014 r
= safe_fork("(with)", FORK_RESET_SIGNALS
|FORK_CLOSE_ALL_FDS
|FORK_DEATHSIG
|FORK_LOG
|FORK_RLIMIT_NOFILE_SAFE
|FORK_REOPEN_LOG
, &pid
);
2018 if (chdir(home
) < 0) {
2019 log_error_errno(errno
, "Failed to change to directory %s: %m", home
);
2023 execvp(cmdline
[0], cmdline
);
2024 log_error_errno(errno
, "Failed to execute %s: %m", cmdline
[0]);
2028 ret
= wait_for_terminate_and_check(cmdline
[0], pid
, WAIT_LOG_ABNORMAL
);
2030 /* Close the fd that pings the home now. */
2031 acquired_fd
= safe_close(acquired_fd
);
2033 r
= bus_message_new_method_call(bus
, &m
, bus_mgr
, "ReleaseHome");
2035 return bus_log_create_error(r
);
2037 r
= sd_bus_message_append(m
, "s", argv
[1]);
2039 return bus_log_create_error(r
);
2041 r
= sd_bus_call(bus
, m
, HOME_SLOW_BUS_CALL_TIMEOUT_USEC
, &error
, NULL
);
2043 if (sd_bus_error_has_name(&error
, BUS_ERROR_HOME_BUSY
))
2044 log_notice("Not deactivating home directory of %s, as it is still used.", argv
[1]);
2046 return log_error_errno(r
, "Failed to release user home: %s", bus_error_message(&error
, r
));
2052 static int lock_all_homes(int argc
, char *argv
[], void *userdata
) {
2053 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
2054 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
2055 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
2058 r
= acquire_bus(&bus
);
2062 r
= bus_message_new_method_call(bus
, &m
, bus_mgr
, "LockAllHomes");
2064 return bus_log_create_error(r
);
2066 r
= sd_bus_call(bus
, m
, HOME_SLOW_BUS_CALL_TIMEOUT_USEC
, &error
, NULL
);
2068 return log_error_errno(r
, "Failed to lock all homes: %s", bus_error_message(&error
, r
));
2073 static int deactivate_all_homes(int argc
, char *argv
[], void *userdata
) {
2074 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
2075 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
2076 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
2079 r
= acquire_bus(&bus
);
2083 r
= bus_message_new_method_call(bus
, &m
, bus_mgr
, "DeactivateAllHomes");
2085 return bus_log_create_error(r
);
2087 r
= sd_bus_call(bus
, m
, HOME_SLOW_BUS_CALL_TIMEOUT_USEC
, &error
, NULL
);
2089 return log_error_errno(r
, "Failed to deactivate all homes: %s", bus_error_message(&error
, r
));
2094 static int rebalance(int argc
, char *argv
[], void *userdata
) {
2095 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
2096 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
2097 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
2100 r
= acquire_bus(&bus
);
2104 r
= bus_message_new_method_call(bus
, &m
, bus_mgr
, "Rebalance");
2106 return bus_log_create_error(r
);
2108 r
= sd_bus_call(bus
, m
, HOME_SLOW_BUS_CALL_TIMEOUT_USEC
, &error
, NULL
);
2110 if (sd_bus_error_has_name(&error
, BUS_ERROR_REBALANCE_NOT_NEEDED
))
2111 log_info("No homes needed rebalancing.");
2113 return log_error_errno(r
, "Failed to rebalance: %s", bus_error_message(&error
, r
));
2115 log_info("Completed rebalancing.");
2120 static int drop_from_identity(const char *field
) {
2125 /* If we are called to update an identity record and drop some field, let's keep track of what to
2126 * remove from the old record */
2127 r
= strv_extend(&arg_identity_filter
, field
);
2131 /* Let's also drop the field if it was previously set to a new value on the same command line */
2132 r
= json_variant_filter(&arg_identity_extra
, STRV_MAKE(field
));
2134 return log_error_errno(r
, "Failed to filter JSON identity data: %m");
2136 r
= json_variant_filter(&arg_identity_extra_this_machine
, STRV_MAKE(field
));
2138 return log_error_errno(r
, "Failed to filter JSON identity data: %m");
2140 r
= json_variant_filter(&arg_identity_extra_privileged
, STRV_MAKE(field
));
2142 return log_error_errno(r
, "Failed to filter JSON identity data: %m");
2147 static int help(int argc
, char *argv
[], void *userdata
) {
2148 _cleanup_free_
char *link
= NULL
;
2151 pager_open(arg_pager_flags
);
2153 r
= terminal_urlify_man("homectl", "1", &link
);
2157 printf("%1$s [OPTIONS...] COMMAND ...\n\n"
2158 "%2$sCreate, manipulate or inspect home directories.%3$s\n"
2159 "\n%4$sCommands:%5$s\n"
2160 " list List home areas\n"
2161 " activate USER… Activate a home area\n"
2162 " deactivate USER… Deactivate a home area\n"
2163 " inspect USER… Inspect a home area\n"
2164 " authenticate USER… Authenticate a home area\n"
2165 " create USER Create a home area\n"
2166 " remove USER… Remove a home area\n"
2167 " update USER Update a home area\n"
2168 " passwd USER Change password of a home area\n"
2169 " resize USER SIZE Resize a home area\n"
2170 " lock USER… Temporarily lock an active home area\n"
2171 " unlock USER… Unlock a temporarily locked home area\n"
2172 " lock-all Lock all suitable home areas\n"
2173 " deactivate-all Deactivate all active home areas\n"
2174 " rebalance Rebalance free space between home areas\n"
2175 " with USER [COMMAND…] Run shell or command with access to a home area\n"
2176 "\n%4$sOptions:%5$s\n"
2177 " -h --help Show this help\n"
2178 " --version Show package version\n"
2179 " --no-pager Do not pipe output into a pager\n"
2180 " --no-legend Do not show the headers and footers\n"
2181 " --no-ask-password Do not ask for system passwords\n"
2182 " -H --host=[USER@]HOST Operate on remote host\n"
2183 " -M --machine=CONTAINER Operate on local container\n"
2184 " --identity=PATH Read JSON identity from file\n"
2185 " --json=FORMAT Output inspection data in JSON (takes one of\n"
2186 " pretty, short, off)\n"
2187 " -j Equivalent to --json=pretty (on TTY) or\n"
2188 " --json=short (otherwise)\n"
2189 " --export-format= Strip JSON inspection data (full, stripped,\n"
2191 " -E When specified once equals -j --export-format=\n"
2192 " stripped, when specified twice equals\n"
2193 " -j --export-format=minimal\n"
2194 "\n%4$sGeneral User Record Properties:%5$s\n"
2195 " -c --real-name=REALNAME Real name for user\n"
2196 " --realm=REALM Realm to create user in\n"
2197 " --email-address=EMAIL Email address for user\n"
2198 " --location=LOCATION Set location of user on earth\n"
2199 " --icon-name=NAME Icon name for user\n"
2200 " -d --home-dir=PATH Home directory\n"
2201 " -u --uid=UID Numeric UID for user\n"
2202 " -G --member-of=GROUP Add user to group\n"
2203 " --skel=PATH Skeleton directory to use\n"
2204 " --shell=PATH Shell for account\n"
2205 " --setenv=VARIABLE[=VALUE] Set an environment variable at log-in\n"
2206 " --timezone=TIMEZONE Set a time-zone\n"
2207 " --language=LOCALE Set preferred language\n"
2208 " --ssh-authorized-keys=KEYS\n"
2209 " Specify SSH public keys\n"
2210 " --pkcs11-token-uri=URI URI to PKCS#11 security token containing\n"
2211 " private key and matching X.509 certificate\n"
2212 " --fido2-device=PATH Path to FIDO2 hidraw device with hmac-secret\n"
2214 " --fido2-with-client-pin=BOOL\n"
2215 " Whether to require entering a PIN to unlock the\n"
2217 " --fido2-with-user-presence=BOOL\n"
2218 " Whether to require user presence to unlock the\n"
2220 " --fido2-with-user-verification=BOOL\n"
2221 " Whether to require user verification to unlock\n"
2223 " --recovery-key=BOOL Add a recovery key\n"
2224 "\n%4$sAccount Management User Record Properties:%5$s\n"
2225 " --locked=BOOL Set locked account state\n"
2226 " --not-before=TIMESTAMP Do not allow logins before\n"
2227 " --not-after=TIMESTAMP Do not allow logins after\n"
2228 " --rate-limit-interval=SECS\n"
2229 " Login rate-limit interval in seconds\n"
2230 " --rate-limit-burst=NUMBER\n"
2231 " Login rate-limit attempts per interval\n"
2232 "\n%4$sPassword Policy User Record Properties:%5$s\n"
2233 " --password-hint=HINT Set Password hint\n"
2234 " --enforce-password-policy=BOOL\n"
2235 " Control whether to enforce system's password\n"
2236 " policy for this user\n"
2237 " -P Same as --enforce-password-password=no\n"
2238 " --password-change-now=BOOL\n"
2239 " Require the password to be changed on next login\n"
2240 " --password-change-min=TIME\n"
2241 " Require minimum time between password changes\n"
2242 " --password-change-max=TIME\n"
2243 " Require maximum time between password changes\n"
2244 " --password-change-warn=TIME\n"
2245 " How much time to warn before password expiry\n"
2246 " --password-change-inactive=TIME\n"
2247 " How much time to block password after expiry\n"
2248 "\n%4$sResource Management User Record Properties:%5$s\n"
2249 " --disk-size=BYTES Size to assign the user on disk\n"
2250 " --access-mode=MODE User home directory access mode\n"
2251 " --umask=MODE Umask for user when logging in\n"
2252 " --nice=NICE Nice level for user\n"
2253 " --rlimit=LIMIT=VALUE[:VALUE]\n"
2254 " Set resource limits\n"
2255 " --tasks-max=MAX Set maximum number of per-user tasks\n"
2256 " --memory-high=BYTES Set high memory threshold in bytes\n"
2257 " --memory-max=BYTES Set maximum memory limit\n"
2258 " --cpu-weight=WEIGHT Set CPU weight\n"
2259 " --io-weight=WEIGHT Set IO weight\n"
2260 "\n%4$sStorage User Record Properties:%5$s\n"
2261 " --storage=STORAGE Storage type to use (luks, fscrypt, directory,\n"
2262 " subvolume, cifs)\n"
2263 " --image-path=PATH Path to image file/directory\n"
2264 " --drop-caches=BOOL Whether to automatically drop caches on logout\n"
2265 "\n%4$sLUKS Storage User Record Properties:%5$s\n"
2266 " --fs-type=TYPE File system type to use in case of luks\n"
2267 " storage (btrfs, ext4, xfs)\n"
2268 " --luks-discard=BOOL Whether to use 'discard' feature of file system\n"
2269 " when activated (mounted)\n"
2270 " --luks-offline-discard=BOOL\n"
2271 " Whether to trim file on logout\n"
2272 " --luks-cipher=CIPHER Cipher to use for LUKS encryption\n"
2273 " --luks-cipher-mode=MODE Cipher mode to use for LUKS encryption\n"
2274 " --luks-volume-key-size=BITS\n"
2275 " Volume key size to use for LUKS encryption\n"
2276 " --luks-pbkdf-type=TYPE Password-based Key Derivation Function to use\n"
2277 " --luks-pbkdf-hash-algorithm=ALGORITHM\n"
2278 " PBKDF hash algorithm to use\n"
2279 " --luks-pbkdf-time-cost=SECS\n"
2280 " Time cost for PBKDF in seconds\n"
2281 " --luks-pbkdf-memory-cost=BYTES\n"
2282 " Memory cost for PBKDF in bytes\n"
2283 " --luks-pbkdf-parallel-threads=NUMBER\n"
2284 " Number of parallel threads for PKBDF\n"
2285 " --luks-extra-mount-options=OPTIONS\n"
2286 " LUKS extra mount options\n"
2287 " --auto-resize-mode=MODE Automatically grow/shrink home on login/logout\n"
2288 " --rebalance-weight=WEIGHT Weight while rebalancing\n"
2289 "\n%4$sMounting User Record Properties:%5$s\n"
2290 " --nosuid=BOOL Control the 'nosuid' flag of the home mount\n"
2291 " --nodev=BOOL Control the 'nodev' flag of the home mount\n"
2292 " --noexec=BOOL Control the 'noexec' flag of the home mount\n"
2293 "\n%4$sCIFS User Record Properties:%5$s\n"
2294 " --cifs-domain=DOMAIN CIFS (Windows) domain\n"
2295 " --cifs-user-name=USER CIFS (Windows) user name\n"
2296 " --cifs-service=SERVICE CIFS (Windows) service to mount as home area\n"
2297 " --cifs-extra-mount-options=OPTIONS\n"
2298 " CIFS (Windows) extra mount options\n"
2299 "\n%4$sLogin Behaviour User Record Properties:%5$s\n"
2300 " --stop-delay=SECS How long to leave user services running after\n"
2302 " --kill-processes=BOOL Whether to kill user processes when sessions\n"
2304 " --auto-login=BOOL Try to log this user in automatically\n"
2305 "\nSee the %6$s for details.\n",
2306 program_invocation_short_name
,
2316 static int parse_argv(int argc
, char *argv
[]) {
2319 ARG_VERSION
= 0x100,
2322 ARG_NO_ASK_PASSWORD
,
2332 ARG_LUKS_OFFLINE_DISCARD
,
2338 ARG_SSH_AUTHORIZED_KEYS
,
2347 ARG_LUKS_CIPHER_MODE
,
2348 ARG_LUKS_VOLUME_KEY_SIZE
,
2355 ARG_CIFS_EXTRA_MOUNT_OPTIONS
,
2361 ARG_LUKS_PBKDF_TYPE
,
2362 ARG_LUKS_PBKDF_HASH_ALGORITHM
,
2363 ARG_LUKS_PBKDF_TIME_COST
,
2364 ARG_LUKS_PBKDF_MEMORY_COST
,
2365 ARG_LUKS_PBKDF_PARALLEL_THREADS
,
2366 ARG_RATE_LIMIT_INTERVAL
,
2367 ARG_RATE_LIMIT_BURST
,
2370 ARG_ENFORCE_PASSWORD_POLICY
,
2371 ARG_PASSWORD_CHANGE_NOW
,
2372 ARG_PASSWORD_CHANGE_MIN
,
2373 ARG_PASSWORD_CHANGE_MAX
,
2374 ARG_PASSWORD_CHANGE_WARN
,
2375 ARG_PASSWORD_CHANGE_INACTIVE
,
2378 ARG_PKCS11_TOKEN_URI
,
2385 ARG_AND_CHANGE_PASSWORD
,
2387 ARG_LUKS_EXTRA_MOUNT_OPTIONS
,
2388 ARG_AUTO_RESIZE_MODE
,
2389 ARG_REBALANCE_WEIGHT
,
2392 static const struct option options
[] = {
2393 { "help", no_argument
, NULL
, 'h' },
2394 { "version", no_argument
, NULL
, ARG_VERSION
},
2395 { "no-pager", no_argument
, NULL
, ARG_NO_PAGER
},
2396 { "no-legend", no_argument
, NULL
, ARG_NO_LEGEND
},
2397 { "no-ask-password", no_argument
, NULL
, ARG_NO_ASK_PASSWORD
},
2398 { "host", required_argument
, NULL
, 'H' },
2399 { "machine", required_argument
, NULL
, 'M' },
2400 { "identity", required_argument
, NULL
, 'I' },
2401 { "real-name", required_argument
, NULL
, 'c' },
2402 { "comment", required_argument
, NULL
, 'c' }, /* Compat alias to keep thing in sync with useradd(8) */
2403 { "realm", required_argument
, NULL
, ARG_REALM
},
2404 { "email-address", required_argument
, NULL
, ARG_EMAIL_ADDRESS
},
2405 { "location", required_argument
, NULL
, ARG_LOCATION
},
2406 { "password-hint", required_argument
, NULL
, ARG_PASSWORD_HINT
},
2407 { "icon-name", required_argument
, NULL
, ARG_ICON_NAME
},
2408 { "home-dir", required_argument
, NULL
, 'd' }, /* Compatible with useradd(8) */
2409 { "uid", required_argument
, NULL
, 'u' }, /* Compatible with useradd(8) */
2410 { "member-of", required_argument
, NULL
, 'G' },
2411 { "groups", required_argument
, NULL
, 'G' }, /* Compat alias to keep thing in sync with useradd(8) */
2412 { "skel", required_argument
, NULL
, 'k' }, /* Compatible with useradd(8) */
2413 { "shell", required_argument
, NULL
, 's' }, /* Compatible with useradd(8) */
2414 { "setenv", required_argument
, NULL
, ARG_SETENV
},
2415 { "timezone", required_argument
, NULL
, ARG_TIMEZONE
},
2416 { "language", required_argument
, NULL
, ARG_LANGUAGE
},
2417 { "locked", required_argument
, NULL
, ARG_LOCKED
},
2418 { "not-before", required_argument
, NULL
, ARG_NOT_BEFORE
},
2419 { "not-after", required_argument
, NULL
, ARG_NOT_AFTER
},
2420 { "expiredate", required_argument
, NULL
, 'e' }, /* Compat alias to keep thing in sync with useradd(8) */
2421 { "ssh-authorized-keys", required_argument
, NULL
, ARG_SSH_AUTHORIZED_KEYS
},
2422 { "disk-size", required_argument
, NULL
, ARG_DISK_SIZE
},
2423 { "access-mode", required_argument
, NULL
, ARG_ACCESS_MODE
},
2424 { "umask", required_argument
, NULL
, ARG_UMASK
},
2425 { "nice", required_argument
, NULL
, ARG_NICE
},
2426 { "rlimit", required_argument
, NULL
, ARG_RLIMIT
},
2427 { "tasks-max", required_argument
, NULL
, ARG_TASKS_MAX
},
2428 { "memory-high", required_argument
, NULL
, ARG_MEMORY_HIGH
},
2429 { "memory-max", required_argument
, NULL
, ARG_MEMORY_MAX
},
2430 { "cpu-weight", required_argument
, NULL
, ARG_CPU_WEIGHT
},
2431 { "io-weight", required_argument
, NULL
, ARG_IO_WEIGHT
},
2432 { "storage", required_argument
, NULL
, ARG_STORAGE
},
2433 { "image-path", required_argument
, NULL
, ARG_IMAGE_PATH
},
2434 { "fs-type", required_argument
, NULL
, ARG_FS_TYPE
},
2435 { "luks-discard", required_argument
, NULL
, ARG_LUKS_DISCARD
},
2436 { "luks-offline-discard", required_argument
, NULL
, ARG_LUKS_OFFLINE_DISCARD
},
2437 { "luks-cipher", required_argument
, NULL
, ARG_LUKS_CIPHER
},
2438 { "luks-cipher-mode", required_argument
, NULL
, ARG_LUKS_CIPHER_MODE
},
2439 { "luks-volume-key-size", required_argument
, NULL
, ARG_LUKS_VOLUME_KEY_SIZE
},
2440 { "luks-pbkdf-type", required_argument
, NULL
, ARG_LUKS_PBKDF_TYPE
},
2441 { "luks-pbkdf-hash-algorithm", required_argument
, NULL
, ARG_LUKS_PBKDF_HASH_ALGORITHM
},
2442 { "luks-pbkdf-time-cost", required_argument
, NULL
, ARG_LUKS_PBKDF_TIME_COST
},
2443 { "luks-pbkdf-memory-cost", required_argument
, NULL
, ARG_LUKS_PBKDF_MEMORY_COST
},
2444 { "luks-pbkdf-parallel-threads", required_argument
, NULL
, ARG_LUKS_PBKDF_PARALLEL_THREADS
},
2445 { "nosuid", required_argument
, NULL
, ARG_NOSUID
},
2446 { "nodev", required_argument
, NULL
, ARG_NODEV
},
2447 { "noexec", required_argument
, NULL
, ARG_NOEXEC
},
2448 { "cifs-user-name", required_argument
, NULL
, ARG_CIFS_USER_NAME
},
2449 { "cifs-domain", required_argument
, NULL
, ARG_CIFS_DOMAIN
},
2450 { "cifs-service", required_argument
, NULL
, ARG_CIFS_SERVICE
},
2451 { "cifs-extra-mount-options", required_argument
, NULL
, ARG_CIFS_EXTRA_MOUNT_OPTIONS
},
2452 { "rate-limit-interval", required_argument
, NULL
, ARG_RATE_LIMIT_INTERVAL
},
2453 { "rate-limit-burst", required_argument
, NULL
, ARG_RATE_LIMIT_BURST
},
2454 { "stop-delay", required_argument
, NULL
, ARG_STOP_DELAY
},
2455 { "kill-processes", required_argument
, NULL
, ARG_KILL_PROCESSES
},
2456 { "enforce-password-policy", required_argument
, NULL
, ARG_ENFORCE_PASSWORD_POLICY
},
2457 { "password-change-now", required_argument
, NULL
, ARG_PASSWORD_CHANGE_NOW
},
2458 { "password-change-min", required_argument
, NULL
, ARG_PASSWORD_CHANGE_MIN
},
2459 { "password-change-max", required_argument
, NULL
, ARG_PASSWORD_CHANGE_MAX
},
2460 { "password-change-warn", required_argument
, NULL
, ARG_PASSWORD_CHANGE_WARN
},
2461 { "password-change-inactive", required_argument
, NULL
, ARG_PASSWORD_CHANGE_INACTIVE
},
2462 { "auto-login", required_argument
, NULL
, ARG_AUTO_LOGIN
},
2463 { "json", required_argument
, NULL
, ARG_JSON
},
2464 { "export-format", required_argument
, NULL
, ARG_EXPORT_FORMAT
},
2465 { "pkcs11-token-uri", required_argument
, NULL
, ARG_PKCS11_TOKEN_URI
},
2466 { "fido2-device", required_argument
, NULL
, ARG_FIDO2_DEVICE
},
2467 { "fido2-with-client-pin", required_argument
, NULL
, ARG_FIDO2_WITH_PIN
},
2468 { "fido2-with-user-presence", required_argument
, NULL
, ARG_FIDO2_WITH_UP
},
2469 { "fido2-with-user-verification",required_argument
, NULL
, ARG_FIDO2_WITH_UV
},
2470 { "recovery-key", required_argument
, NULL
, ARG_RECOVERY_KEY
},
2471 { "and-resize", required_argument
, NULL
, ARG_AND_RESIZE
},
2472 { "and-change-password", required_argument
, NULL
, ARG_AND_CHANGE_PASSWORD
},
2473 { "drop-caches", required_argument
, NULL
, ARG_DROP_CACHES
},
2474 { "luks-extra-mount-options", required_argument
, NULL
, ARG_LUKS_EXTRA_MOUNT_OPTIONS
},
2475 { "auto-resize-mode", required_argument
, NULL
, ARG_AUTO_RESIZE_MODE
},
2476 { "rebalance-weight", required_argument
, NULL
, ARG_REBALANCE_WEIGHT
},
2488 c
= getopt_long(argc
, argv
, "hH:M:I:c:d:u:k:s:e:G:jPE", options
, NULL
);
2495 return help(0, NULL
, NULL
);
2501 arg_pager_flags
|= PAGER_DISABLE
;
2508 case ARG_NO_ASK_PASSWORD
:
2509 arg_ask_password
= false;
2513 arg_transport
= BUS_TRANSPORT_REMOTE
;
2518 arg_transport
= BUS_TRANSPORT_MACHINE
;
2523 arg_identity
= optarg
;
2527 if (isempty(optarg
)) {
2528 r
= drop_from_identity("realName");
2535 if (!valid_gecos(optarg
))
2536 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Real name '%s' not a valid GECOS field.", optarg
);
2538 r
= json_variant_set_field_string(&arg_identity_extra
, "realName", optarg
);
2540 return log_error_errno(r
, "Failed to set realName field: %m");
2545 _cleanup_free_
char *hd
= NULL
;
2547 if (isempty(optarg
)) {
2548 r
= drop_from_identity("homeDirectory");
2555 r
= parse_path_argument(optarg
, false, &hd
);
2559 if (!valid_home(hd
))
2560 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Home directory '%s' not valid.", hd
);
2562 r
= json_variant_set_field_string(&arg_identity_extra
, "homeDirectory", hd
);
2564 return log_error_errno(r
, "Failed to set homeDirectory field: %m");
2570 if (isempty(optarg
)) {
2571 r
= drop_from_identity("realm");
2578 r
= dns_name_is_valid(optarg
);
2580 return log_error_errno(r
, "Failed to determine whether realm '%s' is a valid DNS domain: %m", optarg
);
2582 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Realm '%s' is not a valid DNS domain: %m", optarg
);
2584 r
= json_variant_set_field_string(&arg_identity_extra
, "realm", optarg
);
2586 return log_error_errno(r
, "Failed to set realm field: %m");
2589 case ARG_EMAIL_ADDRESS
:
2592 case ARG_CIFS_USER_NAME
:
2593 case ARG_CIFS_DOMAIN
:
2594 case ARG_CIFS_EXTRA_MOUNT_OPTIONS
:
2595 case ARG_LUKS_EXTRA_MOUNT_OPTIONS
: {
2598 c
== ARG_EMAIL_ADDRESS
? "emailAddress" :
2599 c
== ARG_LOCATION
? "location" :
2600 c
== ARG_ICON_NAME
? "iconName" :
2601 c
== ARG_CIFS_USER_NAME
? "cifsUserName" :
2602 c
== ARG_CIFS_DOMAIN
? "cifsDomain" :
2603 c
== ARG_CIFS_EXTRA_MOUNT_OPTIONS
? "cifsExtraMountOptions" :
2604 c
== ARG_LUKS_EXTRA_MOUNT_OPTIONS
? "luksExtraMountOptions" :
2609 if (isempty(optarg
)) {
2610 r
= drop_from_identity(field
);
2617 r
= json_variant_set_field_string(&arg_identity_extra
, field
, optarg
);
2619 return log_error_errno(r
, "Failed to set %s field: %m", field
);
2624 case ARG_CIFS_SERVICE
:
2625 if (isempty(optarg
)) {
2626 r
= drop_from_identity("cifsService");
2633 r
= parse_cifs_service(optarg
, NULL
, NULL
, NULL
);
2635 return log_error_errno(r
, "Failed to validate CIFS service name: %s", optarg
);
2637 r
= json_variant_set_field_string(&arg_identity_extra
, "cifsService", optarg
);
2639 return log_error_errno(r
, "Failed to set cifsService field: %m");
2643 case ARG_PASSWORD_HINT
:
2644 if (isempty(optarg
)) {
2645 r
= drop_from_identity("passwordHint");
2652 r
= json_variant_set_field_string(&arg_identity_extra_privileged
, "passwordHint", optarg
);
2654 return log_error_errno(r
, "Failed to set passwordHint field: %m");
2656 string_erase(optarg
);
2662 if (isempty(optarg
)) {
2663 r
= drop_from_identity("niceLevel");
2669 r
= parse_nice(optarg
, &nc
);
2671 return log_error_errno(r
, "Failed to parse nice level: %s", optarg
);
2673 r
= json_variant_set_field_integer(&arg_identity_extra
, "niceLevel", nc
);
2675 return log_error_errno(r
, "Failed to set niceLevel field: %m");
2681 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
, *jcur
= NULL
, *jmax
= NULL
;
2682 _cleanup_free_
char *field
= NULL
, *t
= NULL
;
2687 if (isempty(optarg
)) {
2688 /* Remove all resource limits */
2690 r
= drop_from_identity("resourceLimits");
2694 arg_identity_filter_rlimits
= strv_free(arg_identity_filter_rlimits
);
2695 arg_identity_extra_rlimits
= json_variant_unref(arg_identity_extra_rlimits
);
2699 eq
= strchr(optarg
, '=');
2701 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Can't parse resource limit assignment: %s", optarg
);
2703 field
= strndup(optarg
, eq
- optarg
);
2707 l
= rlimit_from_string_harder(field
);
2709 return log_error_errno(l
, "Unknown resource limit type: %s", field
);
2711 if (isempty(eq
+ 1)) {
2712 /* Remove only the specific rlimit */
2714 r
= strv_extend(&arg_identity_filter_rlimits
, rlimit_to_string(l
));
2718 r
= json_variant_filter(&arg_identity_extra_rlimits
, STRV_MAKE(field
));
2720 return log_error_errno(r
, "Failed to filter JSON identity data: %m");
2725 r
= rlimit_parse(l
, eq
+ 1, &rl
);
2727 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Failed to parse resource limit value: %s", eq
+ 1);
2729 r
= rl
.rlim_cur
== RLIM_INFINITY
? json_variant_new_null(&jcur
) : json_variant_new_unsigned(&jcur
, rl
.rlim_cur
);
2731 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Failed to allocate current integer: %m");
2733 r
= rl
.rlim_max
== RLIM_INFINITY
? json_variant_new_null(&jmax
) : json_variant_new_unsigned(&jmax
, rl
.rlim_max
);
2735 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Failed to allocate maximum integer: %m");
2739 JSON_BUILD_PAIR("cur", JSON_BUILD_VARIANT(jcur
)),
2740 JSON_BUILD_PAIR("max", JSON_BUILD_VARIANT(jmax
))));
2742 return log_error_errno(r
, "Failed to build resource limit: %m");
2744 t
= strjoin("RLIMIT_", rlimit_to_string(l
));
2748 r
= json_variant_set_field(&arg_identity_extra_rlimits
, t
, v
);
2750 return log_error_errno(r
, "Failed to set %s field: %m", rlimit_to_string(l
));
2758 if (isempty(optarg
)) {
2759 r
= drop_from_identity("uid");
2766 r
= parse_uid(optarg
, &uid
);
2768 return log_error_errno(r
, "Failed to parse UID '%s'.", optarg
);
2770 if (uid_is_system(uid
))
2771 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "UID " UID_FMT
" is in system range, refusing.", uid
);
2772 if (uid_is_dynamic(uid
))
2773 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "UID " UID_FMT
" is in dynamic range, refusing.", uid
);
2774 if (uid
== UID_NOBODY
)
2775 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "UID " UID_FMT
" is nobody UID, refusing.", uid
);
2777 r
= json_variant_set_field_unsigned(&arg_identity_extra
, "uid", uid
);
2779 return log_error_errno(r
, "Failed to set realm field: %m");
2785 case ARG_IMAGE_PATH
: {
2786 const char *field
= c
== 'k' ? "skeletonDirectory" : "imagePath";
2787 _cleanup_free_
char *v
= NULL
;
2789 if (isempty(optarg
)) {
2790 r
= drop_from_identity(field
);
2797 r
= parse_path_argument(optarg
, false, &v
);
2801 r
= json_variant_set_field_string(&arg_identity_extra_this_machine
, field
, v
);
2803 return log_error_errno(r
, "Failed to set %s field: %m", v
);
2809 if (isempty(optarg
)) {
2810 r
= drop_from_identity("shell");
2817 if (!valid_shell(optarg
))
2818 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Shell '%s' not valid.", optarg
);
2820 r
= json_variant_set_field_string(&arg_identity_extra
, "shell", optarg
);
2822 return log_error_errno(r
, "Failed to set shell field: %m");
2827 _cleanup_free_
char **l
= NULL
;
2828 _cleanup_(json_variant_unrefp
) JsonVariant
*ne
= NULL
;
2831 if (isempty(optarg
)) {
2832 r
= drop_from_identity("environment");
2839 e
= json_variant_by_key(arg_identity_extra
, "environment");
2841 r
= json_variant_strv(e
, &l
);
2843 return log_error_errno(r
, "Failed to parse JSON environment field: %m");
2846 r
= strv_env_replace_strdup_passthrough(&l
, optarg
);
2848 return log_error_errno(r
, "Cannot assign environment variable %s: %m", optarg
);
2852 r
= json_variant_new_array_strv(&ne
, l
);
2854 return log_error_errno(r
, "Failed to allocate environment list JSON: %m");
2856 r
= json_variant_set_field(&arg_identity_extra
, "environment", ne
);
2858 return log_error_errno(r
, "Failed to set environment list: %m");
2865 if (isempty(optarg
)) {
2866 r
= drop_from_identity("timeZone");
2873 if (!timezone_is_valid(optarg
, LOG_DEBUG
))
2874 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Timezone '%s' is not valid.", optarg
);
2876 r
= json_variant_set_field_string(&arg_identity_extra
, "timeZone", optarg
);
2878 return log_error_errno(r
, "Failed to set timezone field: %m");
2883 if (isempty(optarg
)) {
2884 r
= drop_from_identity("language");
2891 if (!locale_is_valid(optarg
))
2892 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Locale '%s' is not valid.", optarg
);
2894 if (locale_is_installed(optarg
) <= 0)
2895 log_warning("Locale '%s' is not installed, accepting anyway.", optarg
);
2897 r
= json_variant_set_field_string(&arg_identity_extra
, "preferredLanguage", optarg
);
2899 return log_error_errno(r
, "Failed to set preferredLanguage field: %m");
2907 case ARG_KILL_PROCESSES
:
2908 case ARG_ENFORCE_PASSWORD_POLICY
:
2909 case ARG_AUTO_LOGIN
:
2910 case ARG_PASSWORD_CHANGE_NOW
: {
2912 c
== ARG_LOCKED
? "locked" :
2913 c
== ARG_NOSUID
? "mountNoSuid" :
2914 c
== ARG_NODEV
? "mountNoDevices" :
2915 c
== ARG_NOEXEC
? "mountNoExecute" :
2916 c
== ARG_KILL_PROCESSES
? "killProcesses" :
2917 c
== ARG_ENFORCE_PASSWORD_POLICY
? "enforcePasswordPolicy" :
2918 c
== ARG_AUTO_LOGIN
? "autoLogin" :
2919 c
== ARG_PASSWORD_CHANGE_NOW
? "passwordChangeNow" :
2924 if (isempty(optarg
)) {
2925 r
= drop_from_identity(field
);
2932 r
= parse_boolean(optarg
);
2934 return log_error_errno(r
, "Failed to parse %s boolean: %m", field
);
2936 r
= json_variant_set_field_boolean(&arg_identity_extra
, field
, r
> 0);
2938 return log_error_errno(r
, "Failed to set %s field: %m", field
);
2944 r
= json_variant_set_field_boolean(&arg_identity_extra
, "enforcePasswordPolicy", false);
2946 return log_error_errno(r
, "Failed to set enforcePasswordPolicy field: %m");
2951 if (isempty(optarg
)) {
2954 FOREACH_STRING(prop
, "diskSize", "diskSizeRelative", "rebalanceWeight") {
2955 r
= drop_from_identity(prop
);
2960 arg_disk_size
= arg_disk_size_relative
= UINT64_MAX
;
2964 r
= parse_permyriad(optarg
);
2966 r
= parse_disk_size(optarg
, &arg_disk_size
);
2970 r
= drop_from_identity("diskSizeRelative");
2974 r
= json_variant_set_field_unsigned(&arg_identity_extra_this_machine
, "diskSize", arg_disk_size
);
2976 return log_error_errno(r
, "Failed to set diskSize field: %m");
2978 arg_disk_size_relative
= UINT64_MAX
;
2980 /* Normalize to UINT32_MAX == 100% */
2981 arg_disk_size_relative
= UINT32_SCALE_FROM_PERMYRIAD(r
);
2983 r
= drop_from_identity("diskSize");
2987 r
= json_variant_set_field_unsigned(&arg_identity_extra_this_machine
, "diskSizeRelative", arg_disk_size_relative
);
2989 return log_error_errno(r
, "Failed to set diskSizeRelative field: %m");
2991 arg_disk_size
= UINT64_MAX
;
2994 /* Automatically turn off the rebalance logic if user configured a size explicitly */
2995 r
= json_variant_set_field_unsigned(&arg_identity_extra_this_machine
, "rebalanceWeight", REBALANCE_WEIGHT_OFF
);
2997 return log_error_errno(r
, "Failed to set rebalanceWeight field: %m");
3001 case ARG_ACCESS_MODE
: {
3004 if (isempty(optarg
)) {
3005 r
= drop_from_identity("accessMode");
3012 r
= parse_mode(optarg
, &mode
);
3014 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Access mode '%s' not valid.", optarg
);
3016 r
= json_variant_set_field_unsigned(&arg_identity_extra
, "accessMode", mode
);
3018 return log_error_errno(r
, "Failed to set access mode field: %m");
3023 case ARG_LUKS_DISCARD
:
3024 if (isempty(optarg
)) {
3025 r
= drop_from_identity("luksDiscard");
3032 r
= parse_boolean(optarg
);
3034 return log_error_errno(r
, "Failed to parse --luks-discard= parameter: %s", optarg
);
3036 r
= json_variant_set_field_boolean(&arg_identity_extra
, "luksDiscard", r
);
3038 return log_error_errno(r
, "Failed to set discard field: %m");
3042 case ARG_LUKS_OFFLINE_DISCARD
:
3043 if (isempty(optarg
)) {
3044 r
= drop_from_identity("luksOfflineDiscard");
3051 r
= parse_boolean(optarg
);
3053 return log_error_errno(r
, "Failed to parse --luks-offline-discard= parameter: %s", optarg
);
3055 r
= json_variant_set_field_boolean(&arg_identity_extra
, "luksOfflineDiscard", r
);
3057 return log_error_errno(r
, "Failed to set offline discard field: %m");
3061 case ARG_LUKS_VOLUME_KEY_SIZE
:
3062 case ARG_LUKS_PBKDF_PARALLEL_THREADS
:
3063 case ARG_RATE_LIMIT_BURST
: {
3065 c
== ARG_LUKS_VOLUME_KEY_SIZE
? "luksVolumeKeySize" :
3066 c
== ARG_LUKS_PBKDF_PARALLEL_THREADS
? "luksPbkdfParallelThreads" :
3067 c
== ARG_RATE_LIMIT_BURST
? "rateLimitBurst" : NULL
;
3072 if (isempty(optarg
)) {
3073 r
= drop_from_identity(field
);
3078 r
= safe_atou(optarg
, &n
);
3080 return log_error_errno(r
, "Failed to parse %s parameter: %s", field
, optarg
);
3082 r
= json_variant_set_field_unsigned(&arg_identity_extra
, field
, n
);
3084 return log_error_errno(r
, "Failed to set %s field: %m", field
);
3092 if (isempty(optarg
)) {
3093 r
= drop_from_identity("umask");
3100 r
= parse_mode(optarg
, &m
);
3102 return log_error_errno(r
, "Failed to parse umask: %m");
3104 r
= json_variant_set_field_integer(&arg_identity_extra
, "umask", m
);
3106 return log_error_errno(r
, "Failed to set umask field: %m");
3111 case ARG_SSH_AUTHORIZED_KEYS
: {
3112 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
3113 _cleanup_(strv_freep
) char **l
= NULL
, **add
= NULL
;
3115 if (isempty(optarg
)) {
3116 r
= drop_from_identity("sshAuthorizedKeys");
3123 if (optarg
[0] == '@') {
3124 _cleanup_fclose_
FILE *f
= NULL
;
3126 /* If prefixed with '@' read from a file */
3128 f
= fopen(optarg
+1, "re");
3130 return log_error_errno(errno
, "Failed to open '%s': %m", optarg
+1);
3133 _cleanup_free_
char *line
= NULL
;
3135 r
= read_line(f
, LONG_LINE_MAX
, &line
);
3137 return log_error_errno(r
, "Failed to read from '%s': %m", optarg
+1);
3147 r
= strv_consume(&add
, TAKE_PTR(line
));
3152 /* Otherwise, assume it's a literal key. Let's do some superficial checks
3153 * before accept it though. */
3155 if (string_has_cc(optarg
, NULL
))
3156 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Authorized key contains control characters, refusing.");
3157 if (optarg
[0] == '#')
3158 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Specified key is a comment?");
3160 add
= strv_new(optarg
);
3165 v
= json_variant_ref(json_variant_by_key(arg_identity_extra_privileged
, "sshAuthorizedKeys"));
3167 r
= json_variant_strv(v
, &l
);
3169 return log_error_errno(r
, "Failed to parse SSH authorized keys list: %m");
3172 r
= strv_extend_strv(&l
, add
, true);
3176 v
= json_variant_unref(v
);
3178 r
= json_variant_new_array_strv(&v
, l
);
3182 r
= json_variant_set_field(&arg_identity_extra_privileged
, "sshAuthorizedKeys", v
);
3184 return log_error_errno(r
, "Failed to set authorized keys: %m");
3189 case ARG_NOT_BEFORE
:
3195 field
= c
== ARG_NOT_BEFORE
? "notBeforeUSec" :
3196 IN_SET(c
, ARG_NOT_AFTER
, 'e') ? "notAfterUSec" : NULL
;
3200 if (isempty(optarg
)) {
3201 r
= drop_from_identity(field
);
3208 /* Note the minor discrepancy regarding -e parsing here: we support that for compat
3209 * reasons, and in the original useradd(8) implementation it accepts dates in the
3210 * format YYYY-MM-DD. Coincidentally, we accept dates formatted like that too, but
3211 * with greater precision. */
3212 r
= parse_timestamp(optarg
, &n
);
3214 return log_error_errno(r
, "Failed to parse %s parameter: %m", field
);
3216 r
= json_variant_set_field_unsigned(&arg_identity_extra
, field
, n
);
3218 return log_error_errno(r
, "Failed to set %s field: %m", field
);
3222 case ARG_PASSWORD_CHANGE_MIN
:
3223 case ARG_PASSWORD_CHANGE_MAX
:
3224 case ARG_PASSWORD_CHANGE_WARN
:
3225 case ARG_PASSWORD_CHANGE_INACTIVE
: {
3229 field
= c
== ARG_PASSWORD_CHANGE_MIN
? "passwordChangeMinUSec" :
3230 c
== ARG_PASSWORD_CHANGE_MAX
? "passwordChangeMaxUSec" :
3231 c
== ARG_PASSWORD_CHANGE_WARN
? "passwordChangeWarnUSec" :
3232 c
== ARG_PASSWORD_CHANGE_INACTIVE
? "passwordChangeInactiveUSec" :
3237 if (isempty(optarg
)) {
3238 r
= drop_from_identity(field
);
3245 r
= parse_sec(optarg
, &n
);
3247 return log_error_errno(r
, "Failed to parse %s parameter: %m", field
);
3249 r
= json_variant_set_field_unsigned(&arg_identity_extra
, field
, n
);
3251 return log_error_errno(r
, "Failed to set %s field: %m", field
);
3257 case ARG_LUKS_CIPHER
:
3258 case ARG_LUKS_CIPHER_MODE
:
3259 case ARG_LUKS_PBKDF_TYPE
:
3260 case ARG_LUKS_PBKDF_HASH_ALGORITHM
: {
3263 c
== ARG_STORAGE
? "storage" :
3264 c
== ARG_FS_TYPE
? "fileSystemType" :
3265 c
== ARG_LUKS_CIPHER
? "luksCipher" :
3266 c
== ARG_LUKS_CIPHER_MODE
? "luksCipherMode" :
3267 c
== ARG_LUKS_PBKDF_TYPE
? "luksPbkdfType" :
3268 c
== ARG_LUKS_PBKDF_HASH_ALGORITHM
? "luksPbkdfHashAlgorithm" : NULL
;
3272 if (isempty(optarg
)) {
3273 r
= drop_from_identity(field
);
3280 if (!string_is_safe(optarg
))
3281 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Parameter for %s field not valid: %s", field
, optarg
);
3283 r
= json_variant_set_field_string(
3284 IN_SET(c
, ARG_STORAGE
, ARG_FS_TYPE
) ?
3285 &arg_identity_extra_this_machine
:
3286 &arg_identity_extra
, field
, optarg
);
3288 return log_error_errno(r
, "Failed to set %s field: %m", field
);
3293 case ARG_LUKS_PBKDF_TIME_COST
:
3294 case ARG_RATE_LIMIT_INTERVAL
:
3295 case ARG_STOP_DELAY
: {
3297 c
== ARG_LUKS_PBKDF_TIME_COST
? "luksPbkdfTimeCostUSec" :
3298 c
== ARG_RATE_LIMIT_INTERVAL
? "rateLimitIntervalUSec" :
3299 c
== ARG_STOP_DELAY
? "stopDelayUSec" :
3305 if (isempty(optarg
)) {
3306 r
= drop_from_identity(field
);
3313 r
= parse_sec(optarg
, &t
);
3315 return log_error_errno(r
, "Failed to parse %s field: %s", field
, optarg
);
3317 r
= json_variant_set_field_unsigned(&arg_identity_extra
, field
, t
);
3319 return log_error_errno(r
, "Failed to set %s field: %m", field
);
3325 const char *p
= optarg
;
3328 r
= drop_from_identity("memberOf");
3336 _cleanup_(json_variant_unrefp
) JsonVariant
*mo
= NULL
;
3337 _cleanup_strv_free_
char **list
= NULL
;
3338 _cleanup_free_
char *word
= NULL
;
3340 r
= extract_first_word(&p
, &word
, ",", 0);
3342 return log_error_errno(r
, "Failed to parse group list: %m");
3346 if (!valid_user_group_name(word
, 0))
3347 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Invalid group name %s.", word
);
3349 mo
= json_variant_ref(json_variant_by_key(arg_identity_extra
, "memberOf"));
3351 r
= json_variant_strv(mo
, &list
);
3353 return log_error_errno(r
, "Failed to parse group list: %m");
3355 r
= strv_extend(&list
, word
);
3362 mo
= json_variant_unref(mo
);
3363 r
= json_variant_new_array_strv(&mo
, list
);
3365 return log_error_errno(r
, "Failed to create group list JSON: %m");
3367 r
= json_variant_set_field(&arg_identity_extra
, "memberOf", mo
);
3369 return log_error_errno(r
, "Failed to update group list: %m");
3375 case ARG_TASKS_MAX
: {
3378 if (isempty(optarg
)) {
3379 r
= drop_from_identity("tasksMax");
3385 r
= safe_atou64(optarg
, &u
);
3387 return log_error_errno(r
, "Failed to parse --tasks-max= parameter: %s", optarg
);
3389 r
= json_variant_set_field_unsigned(&arg_identity_extra
, "tasksMax", u
);
3391 return log_error_errno(r
, "Failed to set tasksMax field: %m");
3396 case ARG_MEMORY_MAX
:
3397 case ARG_MEMORY_HIGH
:
3398 case ARG_LUKS_PBKDF_MEMORY_COST
: {
3400 c
== ARG_MEMORY_MAX
? "memoryMax" :
3401 c
== ARG_MEMORY_HIGH
? "memoryHigh" :
3402 c
== ARG_LUKS_PBKDF_MEMORY_COST
? "luksPbkdfMemoryCost" : NULL
;
3408 if (isempty(optarg
)) {
3409 r
= drop_from_identity(field
);
3415 r
= parse_size(optarg
, 1024, &u
);
3417 return log_error_errno(r
, "Failed to parse %s parameter: %s", field
, optarg
);
3419 r
= json_variant_set_field_unsigned(&arg_identity_extra_this_machine
, field
, u
);
3421 return log_error_errno(r
, "Failed to set %s field: %m", field
);
3426 case ARG_CPU_WEIGHT
:
3427 case ARG_IO_WEIGHT
: {
3428 const char *field
= c
== ARG_CPU_WEIGHT
? "cpuWeight" :
3429 c
== ARG_IO_WEIGHT
? "ioWeight" : NULL
;
3434 if (isempty(optarg
)) {
3435 r
= drop_from_identity(field
);
3441 r
= safe_atou64(optarg
, &u
);
3443 return log_error_errno(r
, "Failed to parse --cpu-weight=/--io-weight= parameter: %s", optarg
);
3445 if (!CGROUP_WEIGHT_IS_OK(u
))
3446 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Weight %" PRIu64
" is out of valid weight range.", u
);
3448 r
= json_variant_set_field_unsigned(&arg_identity_extra
, field
, u
);
3450 return log_error_errno(r
, "Failed to set %s field: %m", field
);
3455 case ARG_PKCS11_TOKEN_URI
: {
3458 if (streq(optarg
, "list"))
3459 return pkcs11_list_tokens();
3461 /* If --pkcs11-token-uri= is specified we always drop everything old */
3462 FOREACH_STRING(p
, "pkcs11TokenUri", "pkcs11EncryptedKey") {
3463 r
= drop_from_identity(p
);
3468 if (isempty(optarg
)) {
3469 arg_pkcs11_token_uri
= strv_free(arg_pkcs11_token_uri
);
3473 if (streq(optarg
, "auto")) {
3474 _cleanup_free_
char *found
= NULL
;
3476 r
= pkcs11_find_token_auto(&found
);
3479 r
= strv_consume(&arg_pkcs11_token_uri
, TAKE_PTR(found
));
3481 if (!pkcs11_uri_valid(optarg
))
3482 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Not a valid PKCS#11 URI: %s", optarg
);
3484 r
= strv_extend(&arg_pkcs11_token_uri
, optarg
);
3489 strv_uniq(arg_pkcs11_token_uri
);
3493 case ARG_FIDO2_DEVICE
: {
3496 if (streq(optarg
, "list"))
3497 return fido2_list_devices();
3499 FOREACH_STRING(p
, "fido2HmacCredential", "fido2HmacSalt") {
3500 r
= drop_from_identity(p
);
3505 if (isempty(optarg
)) {
3506 arg_fido2_device
= strv_free(arg_fido2_device
);
3510 if (streq(optarg
, "auto")) {
3511 _cleanup_free_
char *found
= NULL
;
3513 r
= fido2_find_device_auto(&found
);
3517 r
= strv_consume(&arg_fido2_device
, TAKE_PTR(found
));
3519 r
= strv_extend(&arg_fido2_device
, optarg
);
3523 strv_uniq(arg_fido2_device
);
3527 case ARG_FIDO2_WITH_PIN
: {
3530 r
= parse_boolean_argument("--fido2-with-client-pin=", optarg
, &lock_with_pin
);
3534 SET_FLAG(arg_fido2_lock_with
, FIDO2ENROLL_PIN
, lock_with_pin
);
3538 case ARG_FIDO2_WITH_UP
: {
3541 r
= parse_boolean_argument("--fido2-with-user-presence=", optarg
, &lock_with_up
);
3545 SET_FLAG(arg_fido2_lock_with
, FIDO2ENROLL_UP
, lock_with_up
);
3549 case ARG_FIDO2_WITH_UV
: {
3552 r
= parse_boolean_argument("--fido2-with-user-verification=", optarg
, &lock_with_uv
);
3556 SET_FLAG(arg_fido2_lock_with
, FIDO2ENROLL_UV
, lock_with_uv
);
3560 case ARG_RECOVERY_KEY
: {
3563 r
= parse_boolean(optarg
);
3565 return log_error_errno(r
, "Failed to parse --recovery-key= argument: %s", optarg
);
3567 arg_recovery_key
= r
;
3569 FOREACH_STRING(p
, "recoveryKey", "recoveryKeyType") {
3570 r
= drop_from_identity(p
);
3578 case ARG_AUTO_RESIZE_MODE
:
3579 if (isempty(optarg
)) {
3580 r
= drop_from_identity("autoResizeMode");
3587 r
= auto_resize_mode_from_string(optarg
);
3589 return log_error_errno(r
, "Failed to parse --auto-resize-mode= argument: %s", optarg
);
3591 r
= json_variant_set_field_string(&arg_identity_extra
, "autoResizeMode", auto_resize_mode_to_string(r
));
3593 return log_error_errno(r
, "Failed to set autoResizeMode field: %m");
3597 case ARG_REBALANCE_WEIGHT
: {
3600 if (isempty(optarg
)) {
3601 r
= drop_from_identity("rebalanceWeight");
3606 if (streq(optarg
, "off"))
3607 u
= REBALANCE_WEIGHT_OFF
;
3609 r
= safe_atou64(optarg
, &u
);
3611 return log_error_errno(r
, "Failed to parse --rebalance-weight= argument: %s", optarg
);
3613 if (u
< REBALANCE_WEIGHT_MIN
|| u
> REBALANCE_WEIGHT_MAX
)
3614 return log_error_errno(SYNTHETIC_ERRNO(ERANGE
), "Rebalancing weight out of valid range %" PRIu64
"…%" PRIu64
": %s",
3615 REBALANCE_WEIGHT_MIN
, REBALANCE_WEIGHT_MAX
, optarg
);
3618 /* Drop from per machine stuff and everywhere */
3619 r
= drop_from_identity("rebalanceWeight");
3623 /* Add to main identity */
3624 r
= json_variant_set_field_unsigned(&arg_identity_extra
, "rebalanceWeight", u
);
3626 return log_error_errno(r
, "Failed to set rebalanceWeight field: %m");
3632 arg_json_format_flags
= JSON_FORMAT_PRETTY_AUTO
|JSON_FORMAT_COLOR_AUTO
;
3636 r
= parse_json_argument(optarg
, &arg_json_format_flags
);
3643 if (arg_export_format
== EXPORT_FORMAT_FULL
)
3644 arg_export_format
= EXPORT_FORMAT_STRIPPED
;
3645 else if (arg_export_format
== EXPORT_FORMAT_STRIPPED
)
3646 arg_export_format
= EXPORT_FORMAT_MINIMAL
;
3648 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Specifying -E more than twice is not supported.");
3650 arg_json_format_flags
&= ~JSON_FORMAT_OFF
;
3651 if (arg_json_format_flags
== 0)
3652 arg_json_format_flags
= JSON_FORMAT_PRETTY_AUTO
|JSON_FORMAT_COLOR_AUTO
;
3655 case ARG_EXPORT_FORMAT
:
3656 if (streq(optarg
, "full"))
3657 arg_export_format
= EXPORT_FORMAT_FULL
;
3658 else if (streq(optarg
, "stripped"))
3659 arg_export_format
= EXPORT_FORMAT_STRIPPED
;
3660 else if (streq(optarg
, "minimal"))
3661 arg_export_format
= EXPORT_FORMAT_MINIMAL
;
3662 else if (streq(optarg
, "help")) {
3671 case ARG_AND_RESIZE
:
3672 arg_and_resize
= true;
3675 case ARG_AND_CHANGE_PASSWORD
:
3676 arg_and_change_password
= true;
3679 case ARG_DROP_CACHES
: {
3682 if (isempty(optarg
)) {
3683 r
= drop_from_identity("dropCaches");
3688 r
= parse_boolean_argument("--drop-caches=", optarg
, &drop_caches
);
3692 r
= json_variant_set_field_boolean(&arg_identity_extra
, "dropCaches", r
);
3694 return log_error_errno(r
, "Failed to set drop caches field: %m");
3703 assert_not_reached();
3707 if (!strv_isempty(arg_pkcs11_token_uri
) || !strv_isempty(arg_fido2_device
))
3708 arg_and_change_password
= true;
3710 if (arg_disk_size
!= UINT64_MAX
|| arg_disk_size_relative
!= UINT64_MAX
)
3711 arg_and_resize
= true;
3716 static int redirect_bus_mgr(void) {
3719 /* Talk to a different service if that's requested. (The same env var is also understood by homed, so
3720 * that it is relatively easily possible to invoke a second instance of homed for debug purposes and
3721 * have homectl talk to it, without colliding with the host version. This is handy when operating
3722 * from a homed-managed account.) */
3724 suffix
= getenv("SYSTEMD_HOME_DEBUG_SUFFIX");
3726 static BusLocator locator
= {
3727 .path
= "/org/freedesktop/home1",
3728 .interface
= "org.freedesktop.home1.Manager",
3731 /* Yes, we leak this memory, but there's little point to collect this, given that we only do
3732 * this in a debug environment, do it only once, and the string shall live for out entire
3733 * process runtime. */
3735 locator
.destination
= strjoin("org.freedesktop.home1.", suffix
);
3736 if (!locator
.destination
)
3741 bus_mgr
= bus_home_mgr
;
3746 static int run(int argc
, char *argv
[]) {
3747 static const Verb verbs
[] = {
3748 { "help", VERB_ANY
, VERB_ANY
, 0, help
},
3749 { "list", VERB_ANY
, 1, VERB_DEFAULT
, list_homes
},
3750 { "activate", 2, VERB_ANY
, 0, activate_home
},
3751 { "deactivate", 2, VERB_ANY
, 0, deactivate_home
},
3752 { "inspect", VERB_ANY
, VERB_ANY
, 0, inspect_home
},
3753 { "authenticate", VERB_ANY
, VERB_ANY
, 0, authenticate_home
},
3754 { "create", VERB_ANY
, 2, 0, create_home
},
3755 { "remove", 2, VERB_ANY
, 0, remove_home
},
3756 { "update", VERB_ANY
, 2, 0, update_home
},
3757 { "passwd", VERB_ANY
, 2, 0, passwd_home
},
3758 { "resize", 2, 3, 0, resize_home
},
3759 { "lock", 2, VERB_ANY
, 0, lock_home
},
3760 { "unlock", 2, VERB_ANY
, 0, unlock_home
},
3761 { "with", 2, VERB_ANY
, 0, with_home
},
3762 { "lock-all", VERB_ANY
, 1, 0, lock_all_homes
},
3763 { "deactivate-all", VERB_ANY
, 1, 0, deactivate_all_homes
},
3764 { "rebalance", VERB_ANY
, 1, 0, rebalance
},
3772 r
= redirect_bus_mgr();
3776 r
= parse_argv(argc
, argv
);
3780 return dispatch_verb(argc
, argv
, verbs
, NULL
);
3783 DEFINE_MAIN_FUNCTION_WITH_POSITIVE_FAILURE(run
);