From 3537aa7c549fab88802dff199716557c866c07fb Mon Sep 17 00:00:00 2001 From: Benjamin Gilbert Date: Tue, 21 Mar 2023 01:47:12 -0400 Subject: [PATCH] docs: document command for generating GRUB password hashes --- docs/config-fcos-v1_5.md | 2 +- docs/config-fcos-v1_6_exp.md | 2 +- docs/examples.md | 3 +-- docs/release-notes.md | 1 + 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/config-fcos-v1_5.md b/docs/config-fcos-v1_5.md index fbce1a01..53a2e119 100644 --- a/docs/config-fcos-v1_5.md +++ b/docs/config-fcos-v1_5.md @@ -217,7 +217,7 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s * **_grub_** (object): describes the desired GRUB bootloader configuration. * **_users_** (list of objects): the list of GRUB superusers. * **name** (string): the user name. - * **password_hash** (string): the PBKDF2 password hash. + * **password_hash** (string): the PBKDF2 password hash, generated with `grub2-mkpasswd-pbkdf2`. [part-types]: http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs [rfc2397]: https://tools.ietf.org/html/rfc2397 diff --git a/docs/config-fcos-v1_6_exp.md b/docs/config-fcos-v1_6_exp.md index f099f4ea..6ef82f7c 100644 --- a/docs/config-fcos-v1_6_exp.md +++ b/docs/config-fcos-v1_6_exp.md @@ -219,7 +219,7 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s * **_grub_** (object): describes the desired GRUB bootloader configuration. * **_users_** (list of objects): the list of GRUB superusers. * **name** (string): the user name. - * **password_hash** (string): the PBKDF2 password hash. + * **password_hash** (string): the PBKDF2 password hash, generated with `grub2-mkpasswd-pbkdf2`. [part-types]: http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs [rfc2397]: https://tools.ietf.org/html/rfc2397 diff --git a/docs/examples.md b/docs/examples.md index 767d47af..d9d9a063 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -374,8 +374,7 @@ systemd: ``` ## GRUB password -This example adds a superuser to GRUB and sets a password. Users without the given username -and password will not be able to access GRUB command line, modify kernel command-line arguments, or boot non-default OSTree deployments. +This example adds a superuser to GRUB and sets a password. Users without the given username and password will not be able to access GRUB command line, modify kernel command-line arguments, or boot non-default OSTree deployments. Password hashes can be generated with `grub2-mkpasswd-pbkdf2`. ```yaml diff --git a/docs/release-notes.md b/docs/release-notes.md index e90e34da..3fef3d5a 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -51,6 +51,7 @@ nav_order: 9 - Document that `hash` fields describe decompressed data - Clarify spec docs for `files`/`luks` `hash` fields - Document SSH key file path used by OpenShift 4.13+ _(openshift)_ +- Document command to generate GRUB password hashes ## Butane 0.17.0 (2023-01-04)