passwdqc icon indicating copy to clipboard operation
passwdqc copied to clipboard

Published 20 hours ago • verified publisher icon openwall

Rework README

Open solardiz opened this issue 3 years ago • 2 comments

Our current README dates back to when this was only a PAM module. Now we also have a library and tools. We should replace the contents of README to describe the whole project as it currently is, probably moving most of what's currently in README to a new file - e.g., call it OPTIONS?

solardiz avatar May 28 '22 13:05 solardiz

Yes, this makes sense, there should be a file describing the whole project, but I'm not volunteering to do this job. :) Given that options are also described in passwdqc.conf(5) manual page, maybe the file describing pam_passwdqc should rather focus on other aspects, e.g. pam stack integration.

ldv-alt avatar May 28 '22 15:05 ldv-alt

I was thinking that we wouldn't have a separate text "file describing pam_passwdqc" - rather, the options list moved from README to e.g. OPTIONS would describe the configuration options most of which are not specific to the PAM module alone, but are also supported across other components. Yes, it would be duplicate with passwdqc.conf(5) - just different format.

Currently, PAM stack integration would fit (albeit not perfectly) into PAM-using systems' sections in PLATFORMS.

solardiz avatar May 28 '22 19:05 solardiz