README

Cifrado y descifrado de textos y archivos.

Instalación

Control de versiones

Este proyecto puede ser descargado usando git. Para ello se debe ejecutar en una consola:

git clone https://www.gitlab.com/jfphp/crypto.git
cd crypto

Composer

Este proyecto usa como gestor de dependencias Composer el cual puede ser instalado siguiendo las instrucciones especificadas en la documentación oficial del proyecto.

Para instalar el paquete jf/crypto usando este manejador de paquetes se debe ejecutar:

composer require jf/crypto

Dependencias

Se requiere la versión de PHP >=8.4.

Cuando el proyecto es instalado, adicionalmente se instalan las siguientes dependencias:

Paquete	Versión
jf/base	^5.0

Archivos

Clases

Nombre	Descripción
📖 jf\Crypto\ACipher	Clase para cifrar de manera simple archivos usados como base de datos o configuración.
📖 jf\Crypto\AsymmetricKeys	Gestiona las necesidades el cifrado y descifrado usando claves asimétricas.
📖 jf\Crypto\Cipher	Clase para cifrar de manera simple textos o datos.
📖 jf\Crypto\Codec\ACodec	Clase base para los codificadores de textos.
📖 jf\Crypto\Codec\Base64Std	Encapsula las funciones de Base64 de PHP para que puedan ser usadas como una instancia de `ICodec`.
📖 jf\Crypto\Codec\Base64Url	Encapsula las funciones de Base64 de PHP para que puedan ser usadas como una instancia de `ICodec`.
📖 jf\Crypto\Codec\BaseJF	Ampliación del algoritmo Base64 para reducir los bytes del diccionario de entrada.
📖 jf\Crypto\Codec\BaseN	Convierte un entero a un texto en base N, donde N es la longitud de los caracteres a usar para realizar la representación del valor entero.
📖 jf\Crypto\Codec\BaseWords	Ampliación del algoritmo Base64 para permitir el uso de palabras además de caracteres.
📖 jf\Crypto\Codec\Binary	Codifica/decodifica textos usando diccionarios usando la base binaria como valor intermedio.
📖 jf\Crypto\Codec\Dictionary	Ampliación del algoritmo BaseJF pensado principalmente para codificar enlaces.
📖 jf\Crypto\Codec\Hexadecimal	Codifica y decodifica texto usando caracteres hexadecimales.
📖 jf\Crypto\Codec\Identifier	Ofusca un identificador de un lenguaje de programación.
📖 jf\Crypto\Codec\Mask	Cifra de manera simple un texto.
📖 jf\Crypto\Dict\Ascii	Diccionario con los caracteres ASCII.
📖 jf\Crypto\Dict\Base64Std	Diccionario con los caracteres utilizados en el formato Base64 estándar.
📖 jf\Crypto\Dict\Base64Url	Diccionario con los caracteres utilizados en el formato Base64 usado en URLs.
📖 jf\Crypto\Dict\Dict	Intefaz para los diccionarios usados por los codificadores y decodificadores.
📖 jf\Crypto\Dict\LowerHex	Diccionario con los caracteres hexadecimales en minúsculas.
📖 jf\Crypto\Dict\UpperHex	Diccionario con los caracteres hexadecimales en mayúsculas.
📖 jf\Crypto\Exception	Excepción lanzada por el paquete.
📖 jf\Crypto\FileCipher	Clase para cifrar de manera simple archivos usados como base de datos o configuración.
📖 jf\Crypto\Token\AParameter	Clase abstracta para los parámetros.
📖 jf\Crypto\Token\AToken	Clase base para los diferentes tipos de tokens.
📖 jf\Crypto\Token\Claim\Aud	Audiencia prevista.
📖 jf\Crypto\Token\Claim\Exp	Marca de tiempo del momento de expiración del token.
📖 jf\Crypto\Token\Claim\Fp	Almacena una huella o fingerprint.
📖 jf\Crypto\Token\Claim\Iat	Marca de tiempo de expedición del token.
📖 jf\Crypto\Token\Claim\Ip	Almacena una IP.
📖 jf\Crypto\Token\Claim\Iss	Emisor del token.
📖 jf\Crypto\Token\Claim\Jti	Identificador único del token.
📖 jf\Crypto\Token\Claim\Nbf	No válido antes de la fecha especificada.
📖 jf\Crypto\Token\Claim\Sub	Sujeto del token, p.
📖 jf\Crypto\Token\Header\Alg	Algoritmo de firma del token.
📖 jf\Crypto\Token\Header\Crit	Parámetros críticos que deben ser entendidos y procesados por el receptor del token.
📖 jf\Crypto\Token\Header\Cty	Tipo de contenido que representa el token.
📖 jf\Crypto\Token\Header\Enc	Algoritmo de cifrado del token.
📖 jf\Crypto\Token\Header\Jku	URI del recurso que contiene las claves públicas en formato JSON.
📖 jf\Crypto\Token\Header\Jwk	Clave pública usada para firmar el token.
📖 jf\Crypto\Token\Header\Kid	Texto que sugiere la clave que fue usada para securizar el token.
📖 jf\Crypto\Token\Header\Typ	Tipo de media que representa el token.
📖 jf\Crypto\Token\Header\X5c	Certificado X.
📖 jf\Crypto\Token\Header\X5t	Huella digital SHA-1 codificada en base64 de la codificación DER del certificado X.
📖 jf\Crypto\Token\Header\X5u	URI del recurso que contiene el certificado X.
📖 jf\Crypto\Token\Header\Zip	Algoritmo de compresión del encabezado del token antes del cifrado.
📖 jf\Crypto\Token\Jwe	Gestiona un JWE.
📖 jf\Crypto\Token\Jws	Gestiona un JWS.
📖 jf\Crypto\Token\Jwt	Gestiona un JWT.
📖 jf\Crypto\Token\Parameter	Parámetro genérico.
📖 jf\Crypto\Uuid	Genera un identificador único universal (UUID).

Enumerados

Nombre	Descripción
📖 jf\Crypto\Token\Algorithm	Algoritmo de firma.
📖 jf\Crypto\Token\Encryption	Algoritmo de cifrado.
📖 jf\Crypto\Token\Hmac	Algoritmo de firma digital.
📖 jf\Crypto\Token\Section	Sección a la que pertenece el parámetro.
📖 jf\Crypto\Token\Type	Tipo de token.

Interfaces

Nombre	Descripción
📖 jf\Crypto\Dict\IDict	Intefaz para los diccionarios usados por los codificadores y decodificadores.
📖 jf\Crypto\IAsymmetricKeys	Interfaz para las clases que gestionan claves criptográficas asimétricas.
📖 jf\Crypto\ICipher	Interfaz para cifrar/descifrar textos.
📖 jf\Crypto\ICrypto	Interfaz para las clases que cifra y descifran contenido.
📖 jf\Crypto\ICryptoId	Interfaz para las clases que requieren cifrar su identificador.
📖 jf\Crypto\IFileCipher	Interfaz para cifrar/descifrar archivos.
📖 jf\Crypto\Token\IParameter	Interfaz para los parámetros del token.

Traits

Nombre	Descripción
📖 jf\Crypto\TId	Trait para aplicar a los objetos que necesitan cifrar su identificador numérico.
📖 jf\Crypto\Token\TCipher	Trait para gestionar el cifrador.
📖 jf\Crypto\Token\TNumericDate	Gestiona los parámetros que Representan una marca de tiempo.

Diagrama

Generado con ❤️ usando jfGeneratorDoc 0.1.0

jf / crypto

Package info

Security

Statistics