diff --git a/functions/crack.xml b/functions/crack.xml index 483cae5e2d..dc61aef59f 100644 --- a/functions/crack.xml +++ b/functions/crack.xml @@ -1,12 +1,20 @@ - + Crack functions Crack functions - - + + These functions allow you to use the CrackLib library to test the 'strength' + of a password. In order to use these functions, you must compile PHP with + Crack support by using the + option. + + + More information regarding CrackLib along with the library can be found at + &url.crack;. + @@ -19,13 +27,27 @@ Description - string crack_opendict + resource crack_opendict string dictionary + + Returns a dictionary resource identifier on success, or &false; on failure. + &warn.experimental.func; - &warn.undocumented.func; + crack_opendict opens the specified cracklib + dictionary for use with + crack_check. + + + + Only one dictionary may be open at a time. + + + + See also: crack_check, and + crack_closedict. @@ -39,15 +61,21 @@ Description - string crack_closedict - int - link_identifier + bool crack_closedict + resource + dictionary + + &return.success; + &warn.experimental.func; - &warn.undocumented.func; + crack_closedict closes the dictionary that is + associated with the specified link_identifier. + If link_identifier is not specified, the current + dictionary is closed. @@ -62,7 +90,7 @@ string crack_check - int + resource dictionary string password @@ -70,7 +98,10 @@ &warn.experimental.func; - &warn.undocumented.func; + crack_check performs an obscure check with the given + password on the specified dictionary + . If dictionary is not specified, + the last opened dictionary is used. @@ -90,7 +121,8 @@ &warn.experimental.func; - &warn.undocumented.func; + crack_getlastmessage returns the message from the + last obscure check. @@ -116,5 +148,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 - --> - + --> \ No newline at end of file