extra/crypto/passwd-md5/passwd-md5-docs.factor

   1 ! Copyright (C) 2008 Doug Coleman.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax kernel strings ;
   4 IN: crypto.passwd-md5
   5
   6 HELP: authenticate-password
   7 { $values
   8      { "shadow" string } { "password" string }
   9      { "?" boolean } }
  10 { $description "Encodes the provided password and compares it to the encoded password entry from a shadowed password file." } ;
  11
  12 HELP: parse-shadow-password
  13 { $values
  14      { "string" string }
  15      { "magic" string } { "salt" string } { "password" string } }
  16 { $description "Splits a shadowed password entry into a magic string, a salt, and an encoded password string." } ;
  17
  18 HELP: passwd-md5
  19 { $values
  20      { "magic" string } { "salt" string } { "password" string }
  21      { "bytes" "an md5-shadowed password entry" } }
  22 { $description "Encodes the password with the given magic string and salt to an MD5-shadow password entry." } ;
  23
  24 ARTICLE: "crypto.passwd-md5" "MD5 shadow passwords"
  25 "The " { $vocab-link "crypto.passwd-md5" } " vocabulary can encode passwords for use in an MD5 shadow password file." $nl
  26
  27 "Encoding a password:"
  28 { $subsections passwd-md5 }
  29 "Parsing a shadowed password entry:"
  30 { $subsections parse-shadow-password }
  31 "Authenticating against a shadowed password:"
  32 { $subsections authenticate-password } ;
  33
  34 ABOUT: "crypto.passwd-md5"