srptool(1)

πŸ“¦
version 3.7.9 Β· 4 versions
, in debian bookworm

πŸ’– srptool(1) πŸ’–

okay so bestie, welcome to the User Commands section of the manual, and today's main character is srptool, aka the GnuTLS SRP tool 🌸. yes it's a whole tool. yes it has opinions. let's go 🫢


✨ SYNOPSIS ✨

srptool [-flags] [-flag [value]] [--option-name[[=| ]value]]
heads up: All arguments must be options. like, every single one. no loose little positional strays wandering around, bestie πŸ’…

πŸ¦‹ DESCRIPTION πŸ¦‹

It's a simple program that emulates the programs in the Stanford SRP (Secure Remote Password) libraries, except it does it using GnuTLS. so it's giving "the classic, but rehomed" πŸŽ€

It is intended for use in places where you don't expect SRP authentication to be the used for system users. (yes, that's the sentence, she's a little wobbly but she's ours 😭)

In brief, to use SRP you need to create two files. These are:

  • the password file that holds the users and the verifiers associated with them
  • the configuration file to hold the group parameters (called tpasswd.conf)

so like, two files. one for the people, one for the math. slay ✨


πŸ‘‘ OPTIONS πŸ‘‘

  • -d num, --debug=num β€” Enable debugging. This option takes an integer number as its argument. The value of num is constrained to being:
    • in the range 0 through 9999

Specifies the debug level. crank it up and watch the little guy yap πŸ”₯

  • -i num, --index=num β€” This option takes an integer number as its argument. The default number for this option is:
    • 3
  • -u str, --username=str β€” the username, bestie, you know the vibe πŸ’œ
  • -p str, --passwd=str β€” the password. keep it safe, keep it secret, keep it cute πŸ™ˆ
  • -s num, --salt=num β€” This option takes an integer number as its argument. seasoning for your hashes, lowkey essential πŸ“
  • --verify β€” Verifies the password provided against the password file. it's giving "vibe check, but for credentials" ⭐
  • -v str, --passwd-conf=str β€” Specify a filename or a PKCS #11 URL to read the CAs from.
  • --create-conf=str β€” Generate a password configuration file.

This generates a password configuration file (tpasswd.conf) containing the required for TLS parameters.

  • -v arg, --version=arg β€” Output version of program and exit. The default mode is v, a simple version. The c mode will print copyright information and n will print the full copyright notice. (yes, -v is doing double duty here β€” the page says so, not me 😭)
  • -h, --help β€” Display usage information and exit. your girl never leaves you hanging 🫢
  • -!, --more-help β€” Pass the extended usage information through a pager. the deluxe edition, no cap πŸ“–βœ¨

πŸ§ͺ EXAMPLES πŸ§ͺ

To create tpasswd.conf which holds the g and n values for SRP protocol (generator and a large prime), run:

$ srptool --create-conf /etc/tpasswd.conf

This command will create /etc/tpasswd and will add user 'test' (you will also be prompted for a password). Verifiers are stored by default in the way libsrp expects.

$ srptool --passwd /etc/tpasswd --passwd-conf /etc/tpasswd.conf -u test

This command will check against a password. If the password matches the one in /etc/tpasswd you will get an ok.

$ srptool --passwd /etc/tpasswd --passwd-conf /etc/tpasswd.conf --verify -u test

🌈 EXIT STATUS 🌈

One of the following exit values will be returned:

  1. 0 (EXIT_SUCCESS) β€” Successful program execution. it ate. πŸ’…
  2. 1 (EXIT_FAILURE) β€” The operation failed or the command syntax was not valid. it did not eat. πŸ’€

πŸ” SEE ALSO πŸ”

  • gnutls-cli-debug (1)
  • gnutls-serv (1)
  • srptool (1)
  • psktool (1)
  • certtool (1)

the whole friend group, fr fr 🫢✨


πŸŽ€ AUTHORS πŸŽ€

ngl bestie, the original page just puts the heading here and then... nothing. no names. an empty section. it's giving mystery, it's giving "who did this", it's giving main character energy with no credits πŸ’€

Copyright (C) 2020-2021 Free Software Foundation, and others all rights reserved. This program is released under the terms of the GNU General Public License, version 3 or later.

legal but make it cute. read it though, it matters 🫢


πŸ› BUGS πŸ›

Please send bug reports to: bugs@gnutls.org

not me encouraging you to file a bug but like... if you found one, tell them πŸ’–


okay bestie that's the whole page 🌸 this was srptool(1) from GnuTLS 3.7.9, dated 09 Feb 2023, and you absolutely slayed the read-through. go make your tpasswd.conf, stay hydrated, and remember: every argument must be an option. periodt πŸ’…πŸŽ€βœ¨

πŸ“¦ where this page comes from