diff --git a/functions/crack.xml b/functions/crack.xml index dc61aef59f..6c78fea866 100644 --- a/functions/crack.xml +++ b/functions/crack.xml @@ -1,5 +1,5 @@ - + Crack functions Crack functions @@ -15,13 +15,51 @@ More information regarding CrackLib along with the library can be found at &url.crack;. + + Cracklib is useful in testing the 'strength' of a password that checks + length, use of upper and lower case and a check against the specified CrackLib + dictionary. CrackLib will also give helpful diagnostic messages that will + help 'strengthen' the password. + + + This example shows how to open a CrackLib dictionary, test a given password, + retrieve any diagnostic messages, and close the dictionary. + + CrackLib example + + +]]> + + + + + + If crack_check returns &true;, + crack_getlastmessage will return 'strong password'. + + crack_opendict - Opens a new cracklib dictionary + Opens a new CrackLib dictionary Description @@ -36,7 +74,7 @@ &warn.experimental.func; - crack_opendict opens the specified cracklib + crack_opendict opens the specified CrackLib dictionary for use with crack_check. @@ -55,7 +93,7 @@ crack_closedict - Closes an open cracklib dictionary + Closes an open CrackLib dictionary Description @@ -72,9 +110,9 @@ &warn.experimental.func; - crack_closedict closes the dictionary that is - associated with the specified link_identifier. - If link_identifier is not specified, the current + crack_closedict closes the specified + dictionary identifier. If + dictionary is not specified, the current dictionary is closed. @@ -83,19 +121,22 @@ crack_check - Performs an obscure check with the given password + Performs an obscure check with the given password Description - string crack_check + bool crack_check resource dictionary string password + + Returns &true; if password is strong, or &false; otherwise. + &warn.experimental.func; crack_check performs an obscure check with the given