summaryrefslogtreecommitdiff
path: root/docs/USER_RECORD.md
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2020-04-14 19:05:09 +0200
committerLennart Poettering <lennart@poettering.net>2020-07-01 11:17:28 +0200
commitc0bde0d2402b203207d1ec2f998e661ee0fe177c (patch)
treead4f5ebdece8833fa7160d1051e2c614e8e88767 /docs/USER_RECORD.md
parentd00f318323177268872a1fa8bc140aa76979789d (diff)
downloadsystemd-c0bde0d2402b203207d1ec2f998e661ee0fe177c.tar.gz
user-record: rename JSON field "pkcs11Pin" to "tokenPin"
We'd like to use it for FIDO2 tokens too, and the concept is entirely generic, hence let's just reuse the field, but rename it. Read the old name for compatibility, and treat the old name and the new name as identical for most purposes.
Diffstat (limited to 'docs/USER_RECORD.md')
-rw-r--r--docs/USER_RECORD.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/USER_RECORD.md b/docs/USER_RECORD.md
index 7b6fe47665..2ed043734f 100644
--- a/docs/USER_RECORD.md
+++ b/docs/USER_RECORD.md
@@ -864,8 +864,10 @@ The `secret` field of the top-level user record contains the following fields:
`password` → an array of strings, each containing a plain text password.
-`pkcs11Pin` → an array of strings, each containing a plain text PIN, suitable
-for unlocking PKCS#11 security tokens that require that.
+`tokenPin` → an array of strings, each containing a plain text PIN, suitable
+for unlocking security tokens that require that. (The field `pkcs11Pin` should
+be considered a compatibility alias for this field, and merged with `tokenPin`
+in case both are set.)
`pkcs11ProtectedAuthenticationPathPermitted` → a boolean. If set to true allows
the receiver to use the PKCS#11 "protected authentication path" (i.e. a