working okay now for revamp
[feisty_meow.git] / scripts / security / password_functions.sh
1 #!/bin/bash
2
3 # a set of useful functions for managing operations with passwords.
4 # a set of very simple operations, but the file needs to be protected from
5 # undesirable access.  a good way to do that is to make the file owned by
6 # root, and for it to have permssions of "600" (full access by owner only),
7 # and to only try to read the password file when in sudo mode.  the first
8 # two requirements are done automatically by the store_password function.
9
10 # load_password:
11 # provides a way to read a password out of a file.  the filename is the first
12 # paramater and the variable to fill with the password is the second.
13 function load_password()
14 {
15   local passfile="$1"; shift
16   local varname="$1"; shift
17   if [ -z "$passfile" ]; then
18     echo 'The load_password function needs a filename to read the password from.'
19     return 1
20   fi
21   if [ ! -f "$passfile" ]; then
22     # no file, which is not an error necessarily, but return a blank password
23     # in any case.
24     return 0
25   fi
26   local passwd
27   read passwd < "$passfile"
28
29   # return the password in the variable they provided.
30   eval $varname="$passwd"
31 }
32
33 # stores a password into a password file.  the password file should be the
34 # first parameter and the password should be the second.
35 # this makes sure that only root can read the file.
36 function store_password()
37 {
38   local passfile="$1"; shift
39   local passwd="$1"; shift
40   if [ -z "$passfile" -o -z "$passwd" ]; then
41     echo '
42 The store_password function needs (1) the file to store the password into,
43 and (2) the password that should be stored.
44 '
45     return 1
46   fi
47
48   echo "$passwd" > "$passfile"
49   test_or_die "writing password into the file $passfile"
50
51   chown root:root "$passfile"
52   test_or_die "chowning the password file to root ownership for: $passfile"
53
54   chmod 600 "$passfile"
55   test_or_die "restricting permissions on password file for: $passfile"
56 }
57
58 # reads a password from the console, without echoing the letters when they
59 # are typed.  the prompt to show the user is required as the first parameter,
60 # and the variable to fill with the result is the second parameter.
61 function read_password()
62 {
63   local prompt="$1"; shift
64   local varname="$1"; shift
65 #hmmm: complain if not enough parms.
66   echo -n "$prompt "
67   # turn off echo but remember former setting.
68   stty_orig=`stty -g`
69   stty -echo
70   local the_passwd
71   read the_passwd
72   # turn echo back on.
73   stty $stty_orig
74   # return the password in the variable they provided.
75   eval $varname="$the_passwd"
76 }
77
78