JOSE-SIMPLE - Cifrado y descifrado de datos mediante el estándar JOSE (JSON Object Signing and Encryption).

JOSE-SIMPLE - Cifrado y descifrado de datos mediante el estándar JOSE (JSON Object Signing and Encryption).

 

Jose-Simple simplifica el cifrado y descifrado de datos mediante el estándar JOSE (JSON Object Signing and Encryption).

NPM

Advertencias

Instalación

npm install jose-simple

Enlaces

Uso

const jose = require('jose-simple')
// You need a private / public JWE key pair.
// Either load them from `.pem` files, create them, or somehow acquire them.
// The private key must not have a passphrase or cypher!
// see https://github.com/cisco/node-jose/issues/69#issuecomment-236133179
// see also https://github.com/cisco/node-jose/issues/234#issuecomment-457615794
// see unit tests for a simple example.
 
const { encrypt, decrypt } = jose(privateKey, publicKey)
 
const someData = {
  some: 'amazing data',
  you: 'want to keep hidden',
  from: 'prying eyes'
}
 
encrypt(someData).then(encrypted => {
  console.log('encrypted', encrypted)
  decrypt(encrypted).then(decrypted => {
    console.log('decrypted', decrypted)
    // decrypted will be the same as someData
  })
})

Opciones

Consulte encrypt.js-L660-L668

Puede agregar opciones de la siguiente manera:encrypt

const { encrypt, decrypt } = jose(privateKey, publicKey, {
  format: 'compact'
  protect: true,
  // or any of the encrypt options than can be passed to JWE.createEncrypt.
  // https://github.com/cisco/node-jose/blob/master/lib/jwe/encrypt.js#L660-L668
})

Desarrollo

Rama Estado Cobertura Auditoría Comentario
develop CircleCI codecov Vulnerabilities Trabajo en curso
master CircleCI codecov Vulnerabilities Lanzamiento más reciente

Requisitos previos

  • NodeJS — Se necesita una versión o superior para ejecutar las pruebas a medida que se basan en .10.12.0crypto.generateKeyPair

Pruébalo

  • npm test — ejecuta las pruebas unitarias. Las pruebas también proporcionan un ejemplo de cómo crear pares de claves. (Aprovecha las bibliotecas crypto.generateKeyPair introducidas en el nodo .)10.12.0
  • npm run test:unit:cov — ejecuta las pruebas unitarias con cobertura de código
  • npm run test:mutants — ejecuta las pruebas de mutación

Lint it

npm run lint

Contribuyendo

Las contribuciones son bienvenidas. Consulte CONTRIBUTING para obtener más detalles.