88 lines
2.6 KiB
Markdown
88 lines
2.6 KiB
Markdown
# ipblc
|
|
|
|
[![Build Status](https://drone.paulbsd.com/api/badges/paulbsd/ipblc/status.svg)](https://drone.paulbsd.com/paulbsd/ipblc)
|
|
|
|
## Summary
|
|
|
|
ipblc is client-side intrusion prevention software working closely with ipbl
|
|
It's pub/sub features are websockets based
|
|
|
|
## Howto
|
|
|
|
### Build
|
|
|
|
- Dev:
|
|
|
|
```bash
|
|
cargo build
|
|
```
|
|
|
|
- Release (with compiler optimizations)
|
|
|
|
```bash
|
|
cargo build --release
|
|
```
|
|
|
|
### Usage
|
|
|
|
```
|
|
ipblc is a tool that search and send attacking ip addresses to ipbl
|
|
|
|
Usage: ipblc [OPTIONS]
|
|
|
|
Options:
|
|
-s, --server <server> Sets a http server [default: https://ipbl.paulbsd.com]
|
|
-d Enable debugging
|
|
-h, --help Print help information
|
|
-V, --version Print version information
|
|
```
|
|
|
|
### TODO
|
|
|
|
- ✅ Config centralization (Main config in ipbl)
|
|
- ✅ Handles date in log
|
|
- ✅ Fine grain file opening
|
|
- ✅ Handle zeromq data transfer
|
|
- ✅ Code optimizations (WIP)
|
|
- ✅ Error handing when fetching config
|
|
- ✅ Local bound tcp api socket
|
|
- ✅ ZMQ -> Websocket
|
|
- ✅ Bug in RwLocks (agent often give up)
|
|
- ❌ Create memory friendly structs for ipdata
|
|
|
|
|
|
### Notes
|
|
|
|
See [here](NOTES.md)
|
|
|
|
## License
|
|
|
|
```text
|
|
Copyright (c) 2022, 2023 PaulBSD
|
|
All rights reserved.
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions are met:
|
|
|
|
1. Redistributions of source code must retain the above copyright notice, this
|
|
list of conditions and the following disclaimer.
|
|
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
this list of conditions and the following disclaimer in the documentation
|
|
and/or other materials provided with the distribution.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
|
|
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
|
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
The views and conclusions contained in the software and documentation are those
|
|
of the authors and should not be interpreted as representing official policies,
|
|
either expressed or implied, of this project.
|
|
```
|