Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/z4yx/goauthing
Authentication utility for srun4000 (auth.tsinghua.edu.cn / net.tsinghua.edu.cn / Tsinghua-IPv4)
https://github.com/z4yx/goauthing
golang srun srun4k tsinghua-university tunet
Last synced: 18 days ago
JSON representation
Authentication utility for srun4000 (auth.tsinghua.edu.cn / net.tsinghua.edu.cn / Tsinghua-IPv4)
- Host: GitHub
- URL: https://github.com/z4yx/goauthing
- Owner: z4yx
- License: gpl-3.0
- Created: 2018-06-06T14:49:58.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-31T12:09:58.000Z (2 months ago)
- Last Synced: 2024-10-15T17:50:46.939Z (30 days ago)
- Topics: golang, srun, srun4k, tsinghua-university, tunet
- Language: Go
- Homepage:
- Size: 137 KB
- Stars: 234
- Watchers: 8
- Forks: 25
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GoAuthing
[](https://github.com/z4yx/GoAuthing/actions)
A command-line Tunet (auth4/6.tsinghua.edu.cn, Tsinghua-IPv4) authentication tool.
## Download Binary
Download prebuilt binaries from
Or
## Usage
Simply try `./auth-thu`, then enter your user name and password.
```help
NAME:
auth-thu - Authenticating utility for Tsinghua
USAGE:
auth-thu [options]
auth-thu [options] auth [auth_options]
auth-thu [options] deauth [auth_options]
auth-thu [options] login
auth-thu [options] logout
auth-thu [options] online [online_options]
VERSION:
2.2.1
AUTHORS:
Yuxiang Zhang
Nogeek
ZenithalHourlyRate
Jiajie Chen
KomeijiOcean
Sharzy L
COMMANDS:
auth (default) Auth via auth4/6.tsinghua
OPTIONS:
--ip value authenticating for specified IP address
--no-check, -n skip online checking, always send login request
--logout, -o de-auth of the online account (behaves the same as deauth command, for backward-compatibility)
--ipv6, -6 authenticating for IPv6 (auth6.tsinghua)
--campus-only, -C auth only, no auto-login (v4 only)
--host value use customized hostname of srun4000
--insecure use http instead of https
--keep-online, -k keep online after login
--ac-id value use specified ac_id
deauth De-auth via auth4/6.tsinghua
OPTIONS:
--ip value authenticating for specified IP address
--no-check, -n skip online checking, always send logout request
--ipv6, -6 authenticating for IPv6 (auth6.tsinghua)
--host value use customized hostname of srun4000
--insecure use http instead of https
--ac-id value use specified ac_id
login Login via net.tsinghua
logout Logout via net.tsinghua
online Keep your computer online
OPTIONS:
--auth, -a keep the Auth online only
--ipv6, -6 keep only ipv6 connection online
GLOBAL OPTIONS:
--username name, -u name your TUNET account name
--password password, -p password your TUNET password
--config-file path, -c path path to your config file, default ~/.auth-thu
--hook-success value command line to be executed in shell after successful login/out
--daemonize, -D run without reading username/password from standard input; less log
--debug print debug messages
--help, -h print the help
--version, -v print the version
```
The program looks for a config file in `$XDG_CONFIG_HOME/auth-thu`, `~/.config/auth-thu`, `~/.auth-thu` in order.
Write a config file to store your username & password or other options in the following format.
```json
{
"username": "your-username",
"password": "your-password",
"host": "",
"ip": "166.xxx.xx.xx",
"debug": false,
"useV6": false,
"noCheck": false,
"insecure": false,
"daemonize": false,
"acId": "",
"campusOnly": false
}
```
Unless you have special need, you can only have `username` and `password` field in your config file. For `host`, the default value defined in code should be sufficient hence there should be no need to fill it. `UseV6` automatically determine the `host` to use. For `ip`, unless you are auth/login the other boxes you have(not the box `auth-thu` is running on), you can leave it blank. For those boxes unable to get correct acid themselves, we can specify the acid for them by using `acId`. Other options are self-explanatory.
## Autostart
It is suggested that one configures and runs it manually first with `debug` flag turned on, which ensures the correctness of one's config, then start it as system service. For `daemonize` flag, it forces the program to only log errors, hence debugging should be done earlier and manually. `daemonize` is automatically turned on for system service (ref to associated systemd unit files).
### Systemd
To configure automatic authentication on systemd-based Linux distro, take a look at `docs/systemd` folder. Just modify the path in configuration files, then copy them to `/etc/systemd` folder.
Note that the program should have access to the configuration file.
For `system/goauthing.service`, since it is run as `nobody`, `/etc/goauthing.json` can not be read by it, hence you can use the following command to enable access:
```shell
setfacl -m u:nobody:r /etc/goauthing.json
```
Or, to be more secure, you can choose `system/[email protected]` or `user/goauthing.service` and store the configuration file in the home directory.
### OpenWRT
For OpenWRT users, there are two options available: `goauthing` loading the configuration file, and `goauthing@` interacting with the UCI. The init script should go to the `/etc/init.d/` folder. With the latter, use the following procedure to set up:
```shell
touch /etc/config/goauthing
uci set goauthing.config.username=''
uci set goauthing.config.password=''
uci commit goauthing
/etc/init.d/goauthing enable
/etc/init.d/goauthing start
```
### Docker
For Docker users, you can run the container with a restart policy. An example docker compose is like this:
```yaml
services:
goauthing:
image: ghcr.io/z4yx/goauthing:latest
container_name: goauthing
restart: always
volumes:
- /path/to/your/config:/.auth-thu
command: auth -k
```
## Build
Requires Go 1.11 or above
```shell
export GO111MODULE=on
go build -o auth-thu github.com/z4yx/GoAuthing/cli
```
## Acknowledgments
This project was inspired by the following projects:
-
-