SHRUG-anon

Name	SHRUG-anon JSON
Version	1.0.1 JSON
	download
home_page	https://github.com/gopuman/SHRUG
Summary
upload_time	2022-12-19 15:51:33
maintainer
docs_url	None
author	['Gopal Nambiar', 'Shreyas Madhav', 'Ruthuvikas Ravikumar']
requires_python
license	MIT
keywords	anonymization project
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            SHRUG is a simple Python library that lets users anonymize source and destination IP addresses in packet traces. As of the current release, SHRUG supports the following anonymization algorithms:

1. Randomizer algorithm (**randomizer**)
2. Prefix Preserving algorithm (**prefAnon**) [Using [CryptoPAn](https://github.com/Yawning/cryptopan)]
3. BlackMarker algorithm (**blackMarker**)
4. Permutation algorithm (**permutation**)
5. Truncation algorithm (**truncation**)
6. Reverse Truncation algorithm (**revTruncation**)

## Usage
- Install the package using pip
```
pip install SHRUG-anon
```

- Import the module and the anonymization methods
```
>>> from SHRUG_anon import anonalgos
```

- The read_from method can be used to read a .pcap or .tcpdump file
```
>>> input_pks = anonalgos.read_from("/path/to/pcap/tcpdump/file")
```

- Use one of the six anonymization algorithms on the packet capture stored in the previous step, and store the anonymized packets.
```
>>> anonalgos.randomizer(input_pks)
>>> anonalgos.write_to("/path/to/anonymized/packets/.pcap/.tcpdump")
```

- NOTE: The truncation and reverse truncation algorithms require a second parameter, i.e., the number of bits to be truncated.
```
>>> anonalgos.truncation(input_pks, 12)
``` 

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/gopuman/SHRUG",
    "name": "SHRUG-anon",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "Anonymization project",
    "author": "['Gopal Nambiar', 'Shreyas Madhav', 'Ruthuvikas Ravikumar']",
    "author_email": "gnambiar@ucdavis.edu",
    "download_url": "https://files.pythonhosted.org/packages/57/81/e15259f56cbf33c62f4f0b097a67615ee564996976ef5fb4ddae5bfce532/SHRUG_anon-1.0.1.tar.gz",
    "platform": null,
    "description": "SHRUG is a simple Python library that lets users anonymize source and destination IP addresses in packet traces. As of the current release, SHRUG supports the following anonymization algorithms:\n\n1. Randomizer algorithm (**randomizer**)\n2. Prefix Preserving algorithm (**prefAnon**) [Using [CryptoPAn](https://github.com/Yawning/cryptopan)]\n3. BlackMarker algorithm (**blackMarker**)\n4. Permutation algorithm (**permutation**)\n5. Truncation algorithm (**truncation**)\n6. Reverse Truncation algorithm (**revTruncation**)\n\n## Usage\n- Install the package using pip\n```\npip install SHRUG-anon\n```\n\n- Import the module and the anonymization methods\n```\n>>> from SHRUG_anon import anonalgos\n```\n\n- The read_from method can be used to read a .pcap or .tcpdump file\n```\n>>> input_pks = anonalgos.read_from(\"/path/to/pcap/tcpdump/file\")\n```\n\n- Use one of the six anonymization algorithms on the packet capture stored in the previous step, and store the anonymized packets.\n```\n>>> anonalgos.randomizer(input_pks)\n>>> anonalgos.write_to(\"/path/to/anonymized/packets/.pcap/.tcpdump\")\n```\n\n- NOTE: The truncation and reverse truncation algorithms require a second parameter, i.e., the number of bits to be truncated.\n```\n>>> anonalgos.truncation(input_pks, 12)\n``` \n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "",
    "version": "1.0.1",
    "split_keywords": [
        "anonymization",
        "project"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "ea49b17765386b0e7360c10f13890bc4",
                "sha256": "64ff889140a0f7e67d4a091a69f20b6ba52d66e1b762f293ca26fc9570f36ba9"
            },
            "downloads": -1,
            "filename": "SHRUG_anon-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ea49b17765386b0e7360c10f13890bc4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 3048,
            "upload_time": "2022-12-19T15:51:31",
            "upload_time_iso_8601": "2022-12-19T15:51:31.067330Z",
            "url": "https://files.pythonhosted.org/packages/0d/c9/8d2bd2946a001293ed1290ede84d9355bb41040d4accb1280614159fc3f5/SHRUG_anon-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "bea00dde7ab96cbbdfb2ccef3c5e03cc",
                "sha256": "ae4eae22d78a55c9da04e2c782d02be459cc48e70ede3cca6bb1f7352233952e"
            },
            "downloads": -1,
            "filename": "SHRUG_anon-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "bea00dde7ab96cbbdfb2ccef3c5e03cc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3017,
            "upload_time": "2022-12-19T15:51:33",
            "upload_time_iso_8601": "2022-12-19T15:51:33.029371Z",
            "url": "https://files.pythonhosted.org/packages/57/81/e15259f56cbf33c62f4f0b097a67615ee564996976ef5fb4ddae5bfce532/SHRUG_anon-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-19 15:51:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "gopuman",
    "github_project": "SHRUG",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "shrug-anon"
}