https://github.com/phpgt/cipher
Two-way encryption of messages for secure plain text transmission.
https://github.com/phpgt/cipher
Last synced: 2 months ago
JSON representation
Two-way encryption of messages for secure plain text transmission.
- Host: GitHub
- URL: https://github.com/phpgt/cipher
- Owner: phpgt
- License: mit
- Created: 2022-04-17T16:10:45.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-10-10T20:17:49.000Z (9 months ago)
- Last Synced: 2025-10-23T01:56:28.603Z (8 months ago)
- Language: PHP
- Homepage:
- Size: 75.2 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Two-way encryption of messages for secure plain text transmission.
==================================================================
When messages are passed between two systems over a public network, encryption tools are needed to protect the content in transit. Encrypting and decrypting messages correctly can be fiddly and error-prone, so this library keeps the process small and explicit through the `PlainTextMessage`, `EncryptedMessage`, `CipherText`, `Key`, and `InitVector` abstractions.
Pass your secret message to the `PlainTextMessage` constructor, then call `encrypt()` with a shared `Key` to produce a `CipherText`. The encrypted payload is represented by the cipher text itself plus the IV returned by `getIv()`. Those values can then be passed to the receiver by any communication mechanism, with only the holder of the same shared key able to decrypt the original message.
On the receiving side, construct an `EncryptedMessage` with the incoming cipher text and IV, then call `decrypt()` with the same `Key` to recover the original plain text.
The `CipherText` class also provides a `getUri()` method for creating a pre-encoded URI. A URI containing `cipher` and `iv` query string parameters can then be passed to `EncryptedUri` and decrypted back into a `PlainTextMessage`.
***
## Example usage: transmit an encrypted message over a query string
`sender.php`:
```php
use \GT\Cipher\Message\PlainTextMessage;
use \GT\Cipher\Message\EncryptedMessage;
$privateKey = "This can be any string, but a long random string is best.";
$message = new PlainTextMessage("Hello, PHP.Gt!");
$cipherText = $message->encrypt($privateKey);
header("Location: " . $cipherText->getUri("/receiver.php"));
```
`receiver.php`:
```php
// This key must be the same on the sender and receiver!
use GT\Cipher\EncryptedUri;
$privateKey = "This can be any string, but a long random string is best.";
$uri = new EncryptedUri($_SERVER["REQUEST_URI"]);
$plainText = $uri->decryptMessage($privateKey);
echo $plainText;
// Output: Hello, PHP.Gt!
```
# Proudly sponsored by
[JetBrains Open Source sponsorship program](https://www.jetbrains.com/community/opensource/)
[](https://www.jetbrains.com/community/opensource/)