Move instructions into cli-c for distribution.
This commit is contained in:
Maarten Billemont
84
platform-independent/cli-c/README.md
Normal file
84
platform-independent/cli-c/README.md
Normal file
@@ -0,0 +1,84 @@
|
||||
# Native CLI
|
||||
|
||||
This is a command-line terminal interface to the Master Password standard implementation.
|
||||
|
||||
To use the app, you'll first need to build it, then install it into your system's PATH.
|
||||
|
||||
|
||||
## Building
|
||||
|
||||
To build the code to run on your specific system, run the `build` command:
|
||||
|
||||
./build
|
||||
|
||||
Note that the build depends on your system having certain dependencies already installed.
|
||||
By default, you'll need to have at least `libsodium`, `libjson-c` and `libncurses` installed.
|
||||
|
||||
|
||||
### Details
|
||||
|
||||
The build script comes with a default configuration which can be adjusted. Full details on the build script are available by opening the build script file.
|
||||
|
||||
[targets='...'] [mpw_feature=0|1 ...] [CFLAGS='...'] [LDFLAGS='...'] ./build [cc arguments ...]
|
||||
|
||||
By default, the build script only builds the `mpw` target. You can specify other targets or `all` to build all available targets. These are the currently available targets:
|
||||
|
||||
- `mpw` : The main app. It needs: `mpw_sodium`, optionally supports: `mpw_color`, `mpw_json`.
|
||||
- `mpw-bench` : A benchmark utility. It needs: `mpw_sodium`.
|
||||
- `mpw-tests` : An algorithm test suite. It needs: `mpw_sodium`, `mpw_xml`.
|
||||
|
||||
It is smart to build the test suite along with the app, eg.:
|
||||
|
||||
targets='mpw mpw-tests' ./build
|
||||
|
||||
The needed and supported features determine the dependencies that the build will require. The following features exist:
|
||||
|
||||
- `mpw_sodium` : Use Sodium for the crypto implementation. It needs libsodium.
|
||||
- `mpw_json` : Support JSON-based user configuration format. It needs libjson-c.
|
||||
- `mpw_color` : Show a colorized identicon. It needs libncurses.
|
||||
- `mpw_xml` : Support XML parsing. It needs libxml2.
|
||||
|
||||
By default, all features are enabled. Each feature can be disabled or enabled explicitly by prefixing the build command with an assignment of it to `0` or `1`, eg.:
|
||||
|
||||
mpw_color=0 ./build
|
||||
|
||||
As a result of this command, you'd build the `mpw` target (which supports `mpw_color`) without color support. The build no longer requires `libncurses` but the resulting `mpw` binary will not have support for colorized identicons.
|
||||
|
||||
You can also pass CFLAGS or LDFLAGS to the build, or extra custom compiler arguments as arguments to the build script.
|
||||
For instance, to add a custom library search path, you could use:
|
||||
|
||||
LDFLAGS='-L/usr/local/lib' ./build
|
||||
|
||||
|
||||
## Testing
|
||||
|
||||
Once the client is built, you should run a test suite to make sure everything works as intended.
|
||||
|
||||
There are currently two test suites:
|
||||
|
||||
- `mpw-tests` : Tests the Master Password algorithm implementation.
|
||||
- `mpw-cli-tests` : Tests the CLI application.
|
||||
|
||||
The `mpw-tests` suite is only available if you enabled its target during build (see "Details" above).
|
||||
|
||||
The `mpw-cli-tests` is a Bash shell script, hence depends on your system having Bash available.
|
||||
|
||||
|
||||
## Installing
|
||||
|
||||
Once you're happy with the result, you can install the `mpw` application into your system's `PATH`.
|
||||
|
||||
Generally, all you need to do is copy the `mpw` file into a PATH directory, eg.:
|
||||
|
||||
cp mpw /usr/local/bin/
|
||||
|
||||
The directory that you should copy the `mpw` file into will depend on your system. Also note that `cp` is a POSIX command, if your system is not a POSIX system (eg. Windows) you'll need to adjust accordingly.
|
||||
|
||||
There is also an `install` script to help with this process, though it is a Bash script and therefore requires that you have Bash installed:
|
||||
|
||||
./install
|
||||
|
||||
After installing, you should be able to run `mpw` and use it from anywhere in the terminal:
|
||||
|
||||
mpw -h
|
||||
mpw google.com
|
||||
@@ -45,9 +45,20 @@ fi
|
||||
echo
|
||||
|
||||
inf "You can also save your user name in ~/.bashrc. Leave blank to skip this step."
|
||||
if MP_FULLNAME=$(ask "Your full name:") && [[ $MP_FULLNAME ]] ; then
|
||||
printf 'export MP_FULLNAME=%q\n' "$MP_FULLNAME" >> ~/.bashrc
|
||||
if MPW_FULLNAME=$(ask "Your full name:") && [[ $MPW_FULLNAME ]] ; then
|
||||
printf 'export MPW_FULLNAME=%q\n' "$MPW_FULLNAME" >> ~/.bashrc
|
||||
fi
|
||||
inf "If you have an askpass program you'd like to use, you can specify it here."
|
||||
inf "An askpass program provides a graphical interface for entering things like your master password."
|
||||
inf "Leave blank to skip this step and enter passwords using the terminal."
|
||||
if [[ ! $MPW_ASKPASS ]] && hash ssh-askpass 2>/dev/null; then
|
||||
MPW_ASKPASS=ssh-askpass
|
||||
fi
|
||||
if MPW_ASKPASS=$(ask +"$MPW_ASKPASS" "askpass program:") && [[ $MPW_ASKPASS ]] ; then
|
||||
printf 'export MPW_ASKPASS=%q\n' "$MPW_ASKPASS" >> ~/.bashrc
|
||||
fi
|
||||
echo
|
||||
|
||||
inf "To begin using Master Password, type: mpw [site name]"
|
||||
inf "Shell features installed."
|
||||
inf "To load these convenience features into your already running shell, type: source ~/.bashrc"
|
||||
inf "To begin using Master Password, type: mpw -h or mpw my-site-name"
|
||||
|
||||
Reference in New Issue
Block a user