Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spencerwooo/bitsrun-rs
🌐 A headless login / logout CLI for 10.0.0.55 at BIT, now in Rust. 北京理工大学 10.0.0.55 校园网登录登出的 Rust 实现
https://github.com/spencerwooo/bitsrun-rs
beijing-institute-of-technology bit srun srun-client srun-login
Last synced: 2 months ago
JSON representation
🌐 A headless login / logout CLI for 10.0.0.55 at BIT, now in Rust. 北京理工大学 10.0.0.55 校园网登录登出的 Rust 实现
- Host: GitHub
- URL: https://github.com/spencerwooo/bitsrun-rs
- Owner: spencerwooo
- License: mit
- Created: 2023-11-17T08:31:32.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-26T08:55:32.000Z (8 months ago)
- Last Synced: 2024-04-27T09:04:49.569Z (8 months ago)
- Topics: beijing-institute-of-technology, bit, srun, srun-client, srun-login
- Language: Rust
- Homepage: https://crates.io/crates/bitsrun
- Size: 144 KB
- Stars: 17
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bitsrun
[](https://github.com/spencerwooo/bitsrun-rs/actions/workflows/ci.yml)
[](https://github.com/spencerwooo/bitsrun-rs/actions/workflows/release.yml)
[](https://github.com/spencerwooo/bitsrun-rs/releases/latest)
[](https://crates.io/crates/bitsrun)
🌐 A headless login and logout CLI for 10.0.0.55 at BIT, now in Rust.
## Install
#### One-line install (Linux / macOS, recommended)
- `curl -fsSL https://cdn.jsdelivr.net/gh/spencerwooo/bitsrun-rs@main/install.sh | sh -`
#### Ubuntu / Debian (recommended for `systemd` support)
- Download the latest `.deb` package from [Releases](https://github.com/spencerwooo/bitsrun-rs/releases/latest).
- `sudo apt install .deb`
**If `bitsrun.service` systemd service required:**
- Edit `/lib/systemd/system/bitsrun.service` to specify absolute config path
- Then start service with `sudo systemctl start bitsrun`
#### Cargo
- `cargo install bitsrun`
#### Download binary
- Download the latest binary from [Releases](https://github.com/spencerwooo/bitsrun-rs/releases/latest).
- Uncompress file: `tar -xvf .tar.gz`
- Move binary to `$PATH`, such as: `mv /bitsrun ~/.local/bin/`
## Usage
To log into or out of the campus network, simply:
```console
$ bitsrun login -u -p
bitsrun: () logged in
$ bitsrun logout -u
bitsrun: logged out
```
To check device login status:
```console
$ bitsrun status
bitsrun: () is online
┌────────────────┬───────────────┬───────────────┬─────────┐
│ Traffic Used │ Online Time │ User Balance │ Wallet │
├────────────────┼───────────────┼───────────────┼─────────┤
│ 188.10 GiB │ 2 months │ 10.00 │ 0.00 │
└────────────────┴───────────────┴───────────────┴─────────┘
```
To keep the session alive, use `bitsrun keep-alive`:
```console
$ bitsrun keep-alive
INFO bitsrun::daemon > starting daemon () with polling interval=3600s
INFO bitsrun::daemon > (): login success,
...
^C INFO bitsrun::daemon > : gracefully exiting
```
> [!NOTE]
> Use available system service managers to run `bitsrun keep-alive` as a daemon. (e.g., `systemd` for Linux, `launchd` for macOS, and Windows Service for Windows).
## Available commands
```console
$ bitsrun --help
A headless login and logout CLI for 10.0.0.55 at BIT
Usage: bitsrun [OPTIONS] [COMMAND]
Commands:
login Login to the campus network
logout Logout from the campus network
status Check device login status
config-paths List all possible config file paths
keep-alive Poll the server with login requests to keep the session alive
help Print this message or the help of the given subcommand(s)
Options:
-v, --verbose Verbose output
-h, --help Print help
-V, --version Print version
```
> [!TIP]
> Use environment variable `NO_COLOR=true` to disable colored output.
## Config and credentials
To save your credentials and configurations, create config file `bit-user.json` under an available config path as:
```json
{
"username": "",
"password": "",
"dm": true,
"poll_interval": 3600
}
```
- **`dm` is for specifying whether the current device is a dumb terminal, and requires logging out through the alternative endpoint. Set to `true` (no quotes!) if the device you are working with is a dumb terminal.**
- `poll_interval` is an optional field for specifying the interval (in seconds) of polling login requests. Default is `3600` seconds (1 hour). Used by `bitsrun keep-alive` only.
Available config file paths can be listed with:
```console
$ bitsrun config-paths
bitsrun: list of possible config paths
┌──────────┬─────────────────────────────────────────────────────────────┐
│ Priority │ Possible Config Path │
├──────────┼─────────────────────────────────────────────────────────────┤
│ 1 │ /Users/spencerwoo/.config/bit-user.json │
│ 2 │ /Users/spencerwoo/.config/bitsrun/bit-user.json │
│ 3 │ /Users/spencerwoo/Library/Preferences/bitsrun/bit-user.json │
│ 4 │ bit-user.json │
└──────────┴─────────────────────────────────────────────────────────────┘
```
> [!NOTE]
> The config file location is OS-dependent. Run the command to check the accepted locations on your system.
**Set permissions of this file to `600` on Linux and macOS, or `bitsrun` will refuse to read it.**
```console
$ chmod 600
```
## Related
- [`zu1k/srun`](https://github.com/zu1k/srun) - Srun authentication system login tools. (Rust)
- [`Mmx233/BitSrunLoginGo`](https://github.com/Mmx233/BitSrunLoginGo) - 深澜校园网登录脚本 Go 语言版 (Go)
- [`vouv/srun`](https://github.com/vouv/srun) - An efficient client for BIT campus network. (Go)
- [`BITNP/bitsrun`](https://github.com/BITNP/bitsrun) - A headless login / logout script for 10.0.0.55 at BIT. (Python)
## License
[MIT](./LICENSE)