Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/manmolecular/history-fp
:feet: Create a behavioral fingerprint based on your zsh command line history
https://github.com/manmolecular/history-fp
behavior python simhash similarity-search zsh
Last synced: 29 days ago
JSON representation
:feet: Create a behavioral fingerprint based on your zsh command line history
- Host: GitHub
- URL: https://github.com/manmolecular/history-fp
- Owner: manmolecular
- Created: 2023-08-09T18:05:45.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-08-14T18:48:09.000Z (over 1 year ago)
- Last Synced: 2024-11-16T02:26:53.362Z (3 months ago)
- Topics: behavior, python, simhash, similarity-search, zsh
- Language: Python
- Homepage:
- Size: 6.84 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# history-fp
:feet: Create a behavioral fingerprint based on your zsh command line history
## Description
`history-fp` project allows you to create a unique fingerprint based on your zsh history file.
This fingerprint can be safely shared with anyone to compare your usage behavior and discover similarities.
No 3rd party services or APIs are involved, everything is calculated locally.
## What is the point?
I thought that it would be funny enough to be able to compare my daily command line usage behavior with anyone just by sharing one string and this repo.
You can think of it as a behavioral matching system that answers the questions _"What is my compatibility/likeness/similarity % with someone?"_ or _"How similar are we?"_
No serious application here, but you can use the same approach and techniques in other fields.
## Quick Example
You can use the following example fingerprint to compare it with your usage behavior, the payload is:
```
bmFtZUBleGFtcGxlOjB4NDgwOTUxNDNkOTNlZWMxMDo2NDozOjM6MTAwOjE6MToxMA==
```
- _Which decodes to:_
```
name@example:0x48095143d93eec10:64:3:3:100:1:1:10
```
- _Where the representation format is:_
```
:hex():::::::
```
- _Which was created as:_
```python
from fp import HistoryFingerprint, encode_fp
commands = ["ls", "docker ps", "kubectl", "python3", "git commit"] * 20 # example
fp = HistoryFingerprint(commands).calculate()
payload = encode_fp(fp, "name@example")
print(payload)
```
The following operation will calculate your fp and compare it with the example above:
```bash
make compare payload=bmFtZUBleGFtcGxlOjB4NDgwOTUxNDNkOTNlZWMxMDo2NDozOjM6MTAwOjE6MToxMA==
```
In my case, the example has almost 47% similarity comparing with my behavior:
```
match with 'name@example': 46.875% similarity (different)
```
For you, it can be totally different.
Same way, you can share your fingerprint with someone else to compare. Please, refer to the `Usage` section for more details or use `--help` on module.
## Requirements
No specific requirements or 3rd party dependencies are required, everything is included.
- Python 3
- `python-hashes` package (required modules are already included in the project, [official repository](https://github.com/sean-public/python-hashes))
## Tests
Tested only on macOS, only with zsh.
To make sure that everything works as expected, run smoke tests:
```bash
make tests
```
## Usage
### Create a fingerprint
Create a personal fingerprint based on your zsh history file:
```bash
make create contact=
```
Or:
```bash
python3 fp.py create --history ~/.zsh_history --contact
```
Expected result:
```bash
payload with fingerprint:
```
This payload can be safely shared with anyone to compare.
### Compare a shared fingerprint
Compare someone's fingerprint (as a payload) with your personal fingerprint:
```bash
make compare payload=
```
Or:
```bash
python3 fp.py compare --history ~/.zsh_history --payload
```
Expected result:
```bash
match with '': 100.0% similarity (identical)
```