Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/artginzburg/sudo-touchid
Permanent TouchID support 👆 for `sudo`.
https://github.com/artginzburg/sudo-touchid
authentication bash cli macos security sudo terminal touchid
Last synced: about 2 months ago
JSON representation
Permanent TouchID support 👆 for `sudo`.
- Host: GitHub
- URL: https://github.com/artginzburg/sudo-touchid
- Owner: artginzburg
- License: epl-2.0
- Created: 2021-07-24T14:25:37.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-15T19:38:55.000Z (11 months ago)
- Last Synced: 2024-04-27T19:35:22.923Z (5 months ago)
- Topics: authentication, bash, cli, macos, security, sudo, terminal, touchid
- Language: Shell
- Homepage: https://git.io/sudotouchid
- Size: 2.81 MB
- Stars: 494
- Watchers: 6
- Forks: 13
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sudo-touchid
[](https://github.com/artginzburg/sudo-touchid/releases)
[](https://github.com/artginzburg/sudo-touchid?sponsor=1)
Native and reliable [**TouchID**](https://support.apple.com/en-gb/guide/mac-help/mchl16fbf90a/mac) support for `sudo`
## Try it out without installing
```powershell
curl -sL git.io/sudo-touch-id | sh
```
Now sudo is great, just like Safari — with your fingerprint in Terminal or whatever you're on.
> Don't worry, you can also [reverse](#usage) it without installing
> Please note: without [full installation](#install), TouchID for `sudo` will be disabled after the next macOS *update*.
### Features
- Fast
- Reliable
- Written in Bash — no dependencies!
- Include it to your automated system build — always working and up to date with major macOS upgrades!
## Install
### Via [🍺 Homebrew](https://brew.sh/) (Recommended)
```powershell
brew install artginzburg/tap/sudo-touchid
sudo brew services start sudo-touchid
```
> Check out [the formula](https://github.com/artginzburg/homebrew-tap/blob/main/Formula/sudo-touchid.rb) if you're interested
### Using [`curl`][curl]
```powershell
curl -sL git.io/sudo-touchid | sh
```
[`curl`][curl] is pre-installed in macOS
> Performs automated "manual" installation.
The installation process:
1. Makes the `sudo-touchid` command available.
2. Makes it auto-run on every system launch (using a simple [`launchd`](https://www.launchd.info) daemon with RunAtLoad key set to true), so that when a [macOS update erases our custom `sudo` configuration](https://www.reddit.com/r/MacOS/comments/ey2g5h/etcauto_master_keeps_getting_reset_sonce_catalina/), `sudo-touchid` fixes it again.
## Usage
```ps1
sudo-touchid [options]
# Running without options adds TouchID parameter to sudo configuration
[-v, --version] # Output installed version
# Commands:
[-d, --disable] # Removes TouchID from sudo config
```
if not installed, can be used via [`curl`][curl] bundled with macOS
```ps1
sh <( curl -sL git.io/sudo-touch-id ) [options]
# Reliability — check :)
[-d, --disable] # Removes TouchID from sudo config
```
### Why?
1. Productivity
macOS _updates_ do _reset_ `/etc/pam.d/sudo`, so previously users had to _manually_ edit the file after each upgrade.
> This tool was born to automate the process, allowing for TouchID sudo auth to be **quickly enabled** on a new/clean system.
2. Spreading the technology.
I bet half of you didn't know.
> It was there for a long time.
3. Lightness
The script is small, doesn't need any builds, doesn't need XCode.
##### Code size comparison — previously favoured solution VS. the one you're currently reading:
[](https://github.com/mattrajca/sudo-touchid)
## How does it work?
#### `sudo-touchid.sh` — the script:
- Adds `auth sufficient pam_tid.so` to the top of `/etc/pam.d/sudo` file following [@cabel's advice](https://twitter.com/cabel/status/931292107372838912)
- Creates a backup file named `sudo.bak`.
- Has a `--disable` (`-d`) option that performs the opposite of the steps above.
Non-Homebrew files:
#### `com.user.sudo-touchid.plist` — the property list (global daemon):
- Runs `sudo-touchid.sh` on system reload
> Needed because any following macOS updates just wipe out our custom `sudo`.
#### `install.sh` — the installer:
- Saves `sudo-touchid.sh` as `/usr/local/bin/sudo-touchid` and gives it the permission to execute.
> (yes, that also means you're able to run `sudo-touchid` from Terminal)
- Saves `com.user.sudo-touchid.plist` to `/Library/LaunchDaemons/` so that it's running on boot (requires root permission).
### Manual installation
1. Generally follow the steps provided by the installer in "Non-Homebrew files"
2. If you need to, store `sudo-touchid.sh` anywhere else and replace `/usr/local/bin` in `com.user.sudo-touchid.plist` with the chosen path.
## Contributing
##### [PRs](https://github.com/artginzburg/sudo-touchid/pulls) and [Issues](https://github.com/artginzburg/sudo-touchid/issues/new/choose) are much welcome!
If you don't like something — change it or inform the ones willing to help.
## Related
#### Disabling password prompt for `sudo`
- Change `%admin ALL=(ALL) ALL` to `%admin ALL=(ALL) NOPASSWD: ALL` in `/etc/sudoers`
#### TouchID support in `tmux`
- Have a look at [pam_reattach](https://github.com/fabianishere/pam_reattach) module
#### Apple Watch TouchID support
- Have a look at [pam_watchid](https://github.com/biscuitehh/pam-watchid) module
[curl]: https://curl.se
