Fix comment in fe-auth-scram.c
authorMichael Paquier
Tue, 29 Nov 2022 23:38:27 +0000 (08:38 +0900)
committerMichael Paquier
Tue, 29 Nov 2022 23:38:27 +0000 (08:38 +0900)
The frontend-side routine in charge of building a SCRAM verifier
mentioned that the restrictions applying to SASLprep on the password
with the encoding are described at the top of fe-auth-scram.c, but this
information is in auth-scram.c.

This is wrong since 8f8b9be, so backpatch all the way down as this is an
important documentation bit.

Spotted while reviewing a different patch.

Backpatch-through: 11

src/interfaces/libpq/fe-auth-scram.c

index 6ee51d4e5e79182b4db766dd6de85f39632d8ac6..cd66e9757ba42fb9e467d17c7eadf4b4277d5680 100644 (file)
@@ -926,7 +926,8 @@ pg_fe_scram_build_secret(const char *password, const char **errstr)
    /*
     * Normalize the password with SASLprep.  If that doesn't work, because
     * the password isn't valid UTF-8 or contains prohibited characters, just
-    * proceed with the original password.  (See comments at top of file.)
+    * proceed with the original password.  (See comments at the top of
+    * auth-scram.c.)
     */
    rc = pg_saslprep(password, &prep_password);
    if (rc == SASLPREP_OOM)