diff options
Diffstat (limited to '')
| -rw-r--r-- | README | 1 | ||||
| -rw-r--r-- | info/libpassphrase.texinfo | 46 | ||||
| -rw-r--r-- | src/passphrase.h | 14 | ||||
| -rw-r--r-- | src/passphrase_helper.h | 4 |
4 files changed, 32 insertions, 33 deletions
@@ -1,2 +1 @@ Personalisable library for TTY passphrase reading - diff --git a/info/libpassphrase.texinfo b/info/libpassphrase.texinfo index 9fbb14a..e6c8216 100644 --- a/info/libpassphrase.texinfo +++ b/info/libpassphrase.texinfo @@ -96,8 +96,8 @@ or write your own replacement. To use libpassphrase, add the option @option{-lpassphrase} to the linker. In other words add @option{-lpassphrase} to -the arguments when invoking GCC @footnote{Or your compile -or choice.}, when it creates an executable +the arguments when invoking GCC @footnote{Or your compiler +of choice.}, when it creates an executable file. libpassphrase should be dynamically linked as static @@ -118,7 +118,7 @@ Including @file{passphrase.h} gives you three functions: @itemx void passphrase_disable_echo(void) Invoking @code{passphrase_disable_echo1} will hide the user input in the terminal (unless passphrase -hiding is diabled). This is the first thing you +hiding is disabled). This is the first thing you should call. @code{fdin} should be a file descriptor to the terminal. One can be acquired by opening @file{/dev/tty}. @@ -144,25 +144,25 @@ and is equivalent to @code{passphrase_read2(STDIN_FILENO, 0)}. @code{flags} is used to tweak the behaviour -if the function. It should be a combination +of the function. It should be a combination of the constants @table @code @item PASSPHRASE_READ_EXISTING -@code{passphrase_read2} shall not do any thing +@code{passphrase_read2} shall not do anything special, just accept the passphrase. This should be used when getting authentication. Should not be combined with @code{PASSPHRASE_READ_NEW}. @item PASSPHRASE_READ_NEW -@code{passphrase_read2} shall draw a pasphrase +@code{passphrase_read2} shall draw a passphrase strength meter if such capability is available. This should be used when create a new passphrase. Should not be combined with @code{PASSPHRASE_READ_EXISTING}. @item PASSPHRASE_READ_SCREEN_FREE @code{passphrase_read2} may do as it please with -the the screen. This is only used if combined with +the screen. This is only used if combined with @code{PASSPHRASE_READ_NEW} and not with @code{PASSPHRASE_READ_BELOW_FREE}. @code{passphrase_read2} -will create make a line below the new current +will create a line below the current line and use that line to draw the passphrase strength meter if such capability is available. @@ -199,10 +199,10 @@ and is equivalent to @item void passphrase_wipe(char*, size_t) @itemx void passphrase_wipe1(char*) -When you are done using passhprase you should -erase it from the memory before freeing its -allocation. To do this securtly, call -@code{passphrase_wipe} with the passphase +When you are done using the passphrase you should +erase it from memory before freeing its +allocation. To do this securely, call +@code{passphrase_wipe} with the passphrase as the first argument and the length of the passphrase as the second argument. @@ -315,13 +315,13 @@ using @code{malloc} and wiping the passphrase from the old allocation after duplicating it. @item @code{PASSPHRASE_MOVE} -Add the possibilty to move the point (cursor), +Add the possibility to move the point (cursor), even if the passphrase is hidden this is usable. -If using this options you should use at +If using this option you should use at least one of @code{PASSPHRASE_INSERT} and @code{PASSPHRASE_OVERRIDE}, and at least -on of @code{PASSPHRASE_CONTROL} and +one of @code{PASSPHRASE_CONTROL} and @code{PASSPHRASE_DEDICATED}. Provided that all options that requires @@ -393,7 +393,7 @@ the passphrase before it is completed when it is possible that non-initialised memory is about to be read. -This options is not really needed, but not +This option is not really needed, but not using it means that you can get warnings in @command{valgrind}. @@ -414,15 +414,15 @@ the environment variable @env{LIBPASSPHRASE_METER}. one argument. The selected program must behave similar to @command{passcheck}: for each line to stdin, it must print a non-negative int -integer, optinally coloured with one signal +integer, optionally coloured with one signal escape sequence, followed by a new line or -whitespace; the rest of the is ignored. The +whitespace; the rest is ignored. The program must also accept the flag @code{-r}, telling it not to discard any input. @end table -In addition, you may use the follow flags. +In addition, you may use the following flags. @table @asis @@ -468,19 +468,19 @@ file relative to the @file{src/passphrase_helper.h} and enclosed in ASCII double quotes. The @code{LIST_PASSPHRASE_STRENGTH_LIMITS} should -be define similar to +be defined similar to @example #define LIST_PASSPHRASE_STRENGTH_LIMITS(V) \ X(V == 0, "1;31", "Well-known common password") \ - X(V <= 150, "31", "Extremely week") \ - X(V <= 200, "33", "Week") \ + X(V <= 150, "31", "Extremely weak") \ + X(V <= 200, "33", "Weak") \ X(V <= 250, "32", "Good") \ X(V <= 350, "1;32", "Strong") \ X(1, "1;7;32", "Perfect") @end example The macro @code{X} is defined when the macro [@code{LIST_PASSPHRASE_STRENGTH_LIMITS}] is used. -Its first argument should evalute to truth if +Its first argument should evaluate to truth if @code{V} from @code{LIST_PASSPHRASE_STRENGTH_LIMITS} can be designed in the string in the third argument. It is important that it [the first argument] always diff --git a/src/passphrase.h b/src/passphrase.h index 7f02c09..6379d1c 100644 --- a/src/passphrase.h +++ b/src/passphrase.h @@ -30,7 +30,7 @@ /** - * `passphrase_read2` shall not do any thing + * `passphrase_read2` shall not do anything * special, just accept the passphrase. This should * be used when getting authentication. * Should not be combined with `PASSPHRASE_READ_NEW`. @@ -38,9 +38,9 @@ #define PASSPHRASE_READ_EXISTING 0 /** - * `passphrase_read2` shall draw a pasphrase + * `passphrase_read2` shall draw a passphrase * strength meter if such capability is - * available. This should be used when create + * available. This should be used when creating * a new passphrase. * Should not be combined with `PASSPHRASE_READ_EXISTING`. */ @@ -48,10 +48,10 @@ /** * `passphrase_read2` may do as it please with the - * the screen. This is only used if combined with + * screen. This is only used if combined with * `PASSPHRASE_READ_NEW` and not with * `PASSPHRASE_READ_BELOW_FREE`. `passphrase_read2` - * will create make a line below the new current + * will create a line below the current * line and use that line to draw the passphrase * strength meter if such capability is available. */ @@ -108,7 +108,7 @@ void passphrase_wipe(char*, size_t); void passphrase_wipe1(char*); /** - * Disable echoing and do anything else to the terminal settnings `passphrase_read` requires + * Disable echoing and do anything else to the terminal settings `passphrase_read` requires */ PASSPHRASE_DEPRECATED("Please use 'passphrase_disable_echo1' instead.") void passphrase_disable_echo(void); @@ -120,7 +120,7 @@ PASSPHRASE_DEPRECATED("Please use 'passphrase_reenable_echo1' instead.") void passphrase_reenable_echo(void); /** - * Disable echoing and do anything else to the terminal settnings `passphrase_read2` requires + * Disable echoing and do anything else to the terminal settings `passphrase_read2` requires * * @param fdin File descriptor for input */ diff --git a/src/passphrase_helper.h b/src/passphrase_helper.h index 677ab05..bb5d0b9 100644 --- a/src/passphrase_helper.h +++ b/src/passphrase_helper.h @@ -57,8 +57,8 @@ #else # define LIST_PASSPHRASE_STRENGTH_LIMITS(V) \ X(V == 0, "1;31", "Well-known common password") \ - X(V <= 150, "31", "Extremely week") \ - X(V <= 200, "33", "Week") \ + X(V <= 150, "31", "Extremely weak") \ + X(V <= 200, "33", "Weak") \ X(V <= 250, "32", "Good") \ X(V <= 350, "1;32", "Strong") \ X(1, "1;7;32", "Perfect") |