Merge branch 'master' into master

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at bandie@chaospott.de. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

README.md

@@ -8,7 +8,7 @@ pam\_panic is a PAM module that protects sensitive data and provides a panic fun
 
 
 ## How it works
-You can choose one of two options:
+You can choose from one of two options:
 
 ### Using two removable media
 There are two removable media which work as keys: the auth key and the panic key. The auth key will let you pass to the password prompt whereas the panic key, if provided, will securely erase the LUKS header, rendering the data unreadable.
@@ -17,26 +17,25 @@ There are two removable media which work as keys: the auth key and the panic key
 There are two passwords you are able to set: the key password and the panic password. The key password will let you pass to the original password prompt whereas the panic password, if provided, will securely erase the LUKS header, rendering the data unreadable.
 
 
-
 ## Installation
 You will need GCC or similar, as well as the PAM headers. Some distributions package the PAM headers as `libpam0g-dev`.
 
 To compile and install it, do the following within the project's root directory:
 
-```
-autoreconf -i
-./configure
-make
-sudo make install
+```console
+$ [ ! -e ./configure ] && autoreconf -i
+$ ./configure
+$ make
+$ sudo make install
 ```
 
 Note: the paths of the `reboot`, `poweroff`, and `cryptsetup` commands are passed to the module at compile-time.
 
 ## Preparation
-In that case you want to use removable media:
-You'll need two GPT-formatted removable storage devices, and said devices must have at least one partition. Here's an example `fdisk` session, showing how this might be accomplished:
 
-```
+If you want to use removable media you'll need two GPT-formatted removable storage devices, and said devices must have at least one partition. Here's an example `fdisk` session, showing how this might be accomplished:
+
+```console
 $ sudo fdisk /dev/sdc
 
 Welcome to fdisk (util-linux 2.31.1).
@@ -58,8 +57,10 @@ Command (m for help): w
 
 You'll find the UUID of your partition in `/dev/disk/by-partuuid/`. You can find out which device is which typing `ls -l /dev/disk/by-partuuid/` in your favourite shell.
 
+
+
 ## Configuration
-To configure the module, add the following to the appropriate PAM configuration file(s): (see pam.conf(5) for details on these files).
+To configure the module, add the following to the appropriate PAM configuration file(s): (see `pam.conf(5)` for details on these files)
 
 ### Using the removable media:
 ```
@@ -72,9 +73,11 @@ account    requisite    /usr/local/lib/security/pam_panic.so
 auth       requisite    /usr/local/lib/security/pam_panic.so password reboot serious=<UUID>
 account    requisite    /usr/local/lib/security/pam_panic.so
 ```
+To set your passwords run `pam_panic_pw` as root in your prefered shell.
 
 
-See `man 8 pam_panic` for more.
+## More information
+See `man 8 pam_panic` and `man 1 pam_panic_pw` for more information.
 
 
 ## TODO

configure.ac

@@ -1,4 +1,8 @@
-AC_INIT([pam_panic], [0.1.0], [], [pam_panic])
+AC_INIT(
+    [pam_panic],
+    [0.1.0],
+    [https://github.com/pampanic/pam_panic/issues],
+    [pam_panic])
 AC_CONFIG_AUX_DIR([build-aux])
 AM_INIT_AUTOMAKE([-Wall])
 AC_PREREQ([2.69])