Download the PHP package piggly/php-encryption without Composer

On this page you can find all versions of the php package piggly/php-encryption. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of piggly/php-encryption

Informations about the package php-encryption

Criptografia sem complicação

Latest Version on Packagist

Essa biblioteca foi criada para facilitar e simplificar o processo de criptografia de dados. O intuito dela é prover uma interface simples para conduzir diferentes tipos de criptografia conforme a necessidade.

Toda class de criptografia deve extender a classe BaseCrypto e conter o método createKeys() que retorna uma matriz de chaves em array para auxiliar o processo de criação de chaves segura para o método de criptografia.

Existe, no momento, dois métodos disponíveis:

Se você apreciar a função desta biblioteca e quiser apoiar este trabalho, sinta-se livre para fazer qualquer doação para a chave aleatória Pix aae2196f-5f93-46e4-89e6-73bf4138427b ❤.

Instalação

Essa biblioteca pode ser instalada via Composer com o comando composer require piggly/php-encryption. Recomendamos que, após a instalação, execute o comando composer check-platform-reqs para verificar se você possui as extensões necessárias para utilizar um ou vários métodos de criptografia.

Libsodium

Instale de acordo com o seu sistema operacional. Os procedimentos são diferentes para Linux, Mac e Windows.

A biblioteca Libsodium não é nativa do PHP. Deve ser instalada manualmente para que a classe SolidumCryto opere corretamente. Para isso, no terminado do seu servidor, execute o seguinte comando sudo apt-get install libsodium-dev.

Depois, instale o gerenciador de extensões PECL do PHP (veja aqui) com o seguinte comando sudo apt-get install php-pear. E, por fim, instale a extenção libsodium para o PHP com o comando sudo pecl install -f libsodium e ative-a no php.ini tanto na versão cli quanto na versão fpm.

Conheça mais detalhes da Libsodium aqui.

Como utilizar?

Criptografia básica com OpenSSL

Utilize a classe BasicCrypto para criar operações básicas de criptografia. Para começar sempre gere uma chave segura e salve-a em um ambiente com .env ou similares. Sempre grave em um arquivo que esteja protegido contra leitura de terceiros.

Um jeito simples de gerar uma chave aleatória é utilizando a função BasicCrypto::createKeys(). A função irá retornar um array com a chave secret_key. Depois disso, inicialize a classe com o método BasicCrypto::setKeys() com a secret_key e utilize os métodos BasicCrypto::encrypt() e BasicCrypto::descrypt() para criptografar. Veja:

Criptografia com Sodium

Sodium é uma biblioteca moderna projetada para operações de segurança. Ela é multi plataforma e multi linguagem. Seu objetivo é fornercer as principais operações para construção de ferramentas criptográficas de alto nível.

Uma das maiores vantagens, além de construir uma criptografia segura, é que a biblioteca é portável. Isso significa que você pode criptografar uma mensagem com o PHP e, se desejar, descriptografar com NodeJs, Python e afins.

Utilize a classe SodiumCrypto para criar operações básicas de criptografia e assinatura. Para começar sempre gere uma sequência de chaves seguras e salve-as em um ambiente com .env ou similares. Sempre grave em um arquivo que esteja protegido contra leitura de terceiros.

ATENÇÃO! As chaves para trabalhar com Sodium precisam ser geradas pelos algoritmos da biblioteca. Por tanto, sempre utilize o método SodiumCrypto::createKeys(). O método irá retornar um array com as seguintes chaves:

Chave Descrição
pub_key Chave pública para criptografia.
priv_key Chave privada para criptografia.
signature_pub_key Chave pública para assinatura.
signature_priv_key Chave privada para assinatura.

Após gerar e salvar as chaves, inicialize a classe com o método SodiumCrypto::setKeys() definindo todas as chaves requeridas. Por fim, utilize os métodos SodiumCrypto::encrypt() e SodiumCrypto::descrypt() para criptografar e os métodos SodiumCrypto::sign() e SodiumCrypto::checkSignature() para assinar e verificar a assinatura respectivamente. Veja:

Criptografia != Assinatura

Ao utilizar o método SodiumCrypto::sign() a mensagem NÃO É criptografada. Neste caso, a mensagem será apenas assinada para garantir que ela não sofra alterações durante o processo de ida e vinda. Mas, ainda é possível criptografá-la:

Changelog

Veja o arquivo CHANGELOG para informações sobre todas as mudanças no código.

Testes de Código

Essa biblioteca utiliza o PHPUnit. Realizamos testes com todas as principais classes dessa aplicação.

Contribuições

Veja o arquivo CONTRIBUTING para informações antes de enviar sua contribuição.

Segurança

Se você descobrir qualquer issue relacionada a segurança, por favor, envie um e-mail para [email protected] ao invés de utilizar o rastreador de issues do Github.

Créditos

Apoie o projeto

Piggly Studio é uma agência localizada no Rio de Janeiro, Brasil. Se você apreciar a função desta biblioteca e quiser apoiar este trabalho, sinta-se livre para fazer qualquer doação para a chave aleatória Pix aae2196f-5f93-46e4-89e6-73bf4138427b ❤.

Licença

MIT License (MIT). Veja LICENSE para mais informações.

All versions of php-encryption with dependencies

PHP Build Version
Package Version
Requires php Version ^7.2
ext-sodium Version *
ext-openssl Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package piggly/php-encryption contains the following files

Loading the files please wait ....