diff --git a/Cargo.toml b/Cargo.toml index 2ce1067..21d29df 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -7,7 +7,7 @@ description = "Simple, reusable and optimized XOR ciphers in Python (core)." documentation = "https://docs.xor-cipher.org/" readme = "README.md" homepage = "https://xor-cipher.org/" -repository = "https://github.com/xor-cipher/xor-cipher" +repository = "https://github.com/xor-cipher/xor-cipher-core" license = "MIT" keywords = ["xor", "cipher", "core"] publish = false diff --git a/README.md b/README.md index bbe0a17..e1e903f 100644 --- a/README.md +++ b/README.md @@ -3,58 +3,52 @@ [![License][License Badge]][License] [![Version][Version Badge]][Package] [![Downloads][Downloads Badge]][Package] - -[![Documentation][Documentation Badge]][Documentation] -[![Check][Check Badge]][Actions] [![Test][Test Badge]][Actions] -[![Coverage][Coverage Badge]][Coverage] > *Simple, reusable and optimized XOR ciphers in Python (core).* -`xor-cipher` is a fast implementation of the XOR cipher written using Rust. -Our tests show that it can be `1000x` faster than pure Python implementations. -It has been optimized to breeze through datasets of any size. +`xor-cipher-core` is the core of `xor-cipher`. ## Installing **Python 3.8 or above is required.** -### pip +### `pip` Installing the library with `pip` is quite simple: ```console -$ pip install xor-cipher +$ pip install xor-cipher-core ``` Alternatively, the library can be installed from source: ```console -$ git clone https://github.com/xor-cipher/xor-cipher.git -$ cd xor-cipher -$ python -m pip install . +$ git clone https://github.com/xor-cipher/xor-cipher-core.git +$ cd xor-cipher-core +$ pip install . ``` -### poetry +### `poetry` -You can add `xor-cipher` as a dependency with the following command: +You can add `xor-cipher-core` as a dependency with the following command: ```console -$ poetry add xor-cipher +$ poetry add xor-cipher-core ``` Or by directly specifying it in the configuration like so: ```toml [tool.poetry.dependencies] -xor-cipher = "^4.0.0" +xor-cipher-core = "^1.0.0" ``` Alternatively, you can add it directly from the source: ```toml -[tool.poetry.dependencies.xor-cipher] -git = "https://github.com/xor-cipher/xor-cipher.git" +[tool.poetry.dependencies.xor-cipher-core] +git = "https://github.com/xor-cipher/xor-cipher-core.git" ``` ## Examples @@ -64,7 +58,7 @@ git = "https://github.com/xor-cipher/xor-cipher.git" Use the `xor` function to perform the simple XOR cipher: ```python ->>> from xor_cipher import xor +>>> from xor_cipher.core import xor >>> xor(b"Hello, world!", 0x42) b"\n'..-nb5-0.&c" ``` @@ -74,7 +68,7 @@ b"\n'..-nb5-0.&c" Use the `cyclic_xor` function to perform the cyclic XOR variation: ```python ->>> from xor_cipher import cyclic_xor +>>> from xor_cipher.core import cyclic_xor >>> cyclic_xor(b"Hello, world!", b"BLOB") b"\n)#.-`o5->#&c" ``` @@ -84,7 +78,7 @@ b"\n)#.-`o5->#&c" There are functions to perform the XOR cipher in-place, on `bytearray` instances: ```python ->>> from xor_cipher import xor_in_place +>>> from xor_cipher.core import xor_in_place >>> data = bytearray(b"Hello, world!") >>> xor_in_place(data, 0x42) >>> data @@ -105,37 +99,33 @@ You can find the changelog [here][Changelog]. ## Security Policy -You can find the Security Policy of `xor-cipher` [here][Security]. +You can find the Security Policy of `xor-cipher-core` [here][Security]. ## Contributing -If you are interested in contributing to `xor-cipher`, make sure to take a look at the +If you are interested in contributing to `xor-cipher-core`, make sure to take a look at the [Contributing Guide][Contributing Guide], as well as the [Code of Conduct][Code of Conduct]. ## License -`xor-cipher` is licensed under the MIT License terms. See [License][License] for details. +`xor-cipher-core` is licensed under the MIT License terms. See [License][License] for details. [Email]: mailto:support@xor-cipher.org -[Actions]: https://github.com/xor-cipher/xor-cipher/actions +[Actions]: https://github.com/xor-cipher/xor-cipher-core/actions -[Changelog]: https://github.com/xor-cipher/xor-cipher/blob/main/CHANGELOG.md -[Code of Conduct]: https://github.com/xor-cipher/xor-cipher/blob/main/CODE_OF_CONDUCT.md -[Contributing Guide]: https://github.com/xor-cipher/xor-cipher/blob/main/CONTRIBUTING.md -[Security]: https://github.com/xor-cipher/xor-cipher/blob/main/SECURITY.md +[Changelog]: https://github.com/xor-cipher/xor-cipher-core/blob/main/CHANGELOG.md +[Code of Conduct]: https://github.com/xor-cipher/xor-cipher-core/blob/main/CODE_OF_CONDUCT.md +[Contributing Guide]: https://github.com/xor-cipher/xor-cipher-core/blob/main/CONTRIBUTING.md +[Security]: https://github.com/xor-cipher/xor-cipher-core/blob/main/SECURITY.md -[License]: https://github.com/xor-cipher/xor-cipher/blob/main/LICENSE +[License]: https://github.com/xor-cipher/xor-cipher-core/blob/main/LICENSE -[Package]: https://pypi.org/project/xor-cipher -[Coverage]: https://codecov.io/gh/xor-cipher/xor-cipher +[Package]: https://pypi.org/project/xor-cipher-core [Documentation]: https://docs.xor-cipher.org/ -[License Badge]: https://img.shields.io/pypi/l/xor-cipher -[Version Badge]: https://img.shields.io/pypi/v/xor-cipher -[Downloads Badge]: https://img.shields.io/pypi/dm/xor-cipher +[License Badge]: https://img.shields.io/pypi/l/xor-cipher-core +[Version Badge]: https://img.shields.io/pypi/v/xor-cipher-core +[Downloads Badge]: https://img.shields.io/pypi/dm/xor-cipher-core -[Documentation Badge]: https://github.com/xor-cipher/xor-cipher/workflows/docs/badge.svg -[Check Badge]: https://github.com/xor-cipher/xor-cipher/workflows/check/badge.svg -[Test Badge]: https://github.com/xor-cipher/xor-cipher/workflows/test/badge.svg -[Coverage Badge]: https://codecov.io/gh/xor-cipher/xor-cipher/branch/main/graph/badge.svg +[Test Badge]: https://github.com/xor-cipher/xor-cipher-core/workflows/test/badge.svg diff --git a/SECURITY.md b/SECURITY.md index 5c5de1b..497cff4 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -6,7 +6,7 @@ Thank you for taking the time to responsibly disclose any problems you find. **Do not file public issues as they are open for everyone to see!** -All security vulnerabilities in `xor-cipher` should be reported by email +All security vulnerabilities in `xor-cipher-core` should be reported by email to [security@xor-cipher.org][Security Email]. Your report will be acknowledged within 24 hours, and you will receive a more detailed response within 48 hours indicating the next steps in handling your report. @@ -23,7 +23,7 @@ more likely to be every 24-48 hours. ## Disclosure Policy -`xor-cipher` has a 5-step disclosure process: +`xor-cipher-core` has a 5-step disclosure process: 1. The security report is received and is assigned a primary handler. This person will coordinate the fix and release process. diff --git a/pyproject.toml b/pyproject.toml index 6ca58aa..30cf6a7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -26,8 +26,8 @@ classifiers = [ [project.urls] Homepage = "https://xor-cipher.org/" Documentation = "https://docs.xor-cipher.org/" -Issues = "https://github.com/xor-cipher/xor-cipher/issues" -Repository = "https://github.com/xor-cipher/xor-cipher" +Issues = "https://github.com/xor-cipher/xor-cipher-core/issues" +Repository = "https://github.com/xor-cipher/xor-cipher-core" [tool.maturin] module-name = "xor_cipher.core"