miniLockLib

Generates a key pair from a secretPhrase and emailAddress. Returns a KeyPairOperation. Your callback should be prepared to receive a set of keys or an error.

secretPhrase = document.querySelector("#secret_phrase_input").value
emailAddress = document.querySelector("#email_address_input").value

miniLockLib.makeKeyPair(secretPhrase, emailAddress, function(error, keys){
  if (keys) {
    keys.publicKey is a Uint8Array
    keys.secretKey is a Uint8Array
  } else {
    error is a String
  }
})

secretPhrase and emailAddress are both tested to ensure they meet miniLock’s input requirements. If either input is unacceptable your callback will receive one of the following error strings:

• "Can’t make keys without a secret phrase."
• "Can’t make keys because secretPhrase is not an acceptable secret phrase."
• "Can’t make keys without an email address."
• "Can’t make keys because emailAddress is not an acceptable email address."

If all the input is OK your callback will receive a set of keys when the operation is complete. It typically takes two-to-three seconds to complete a key pair operation.

Make a miniLock file. Returns a EncryptOperation.

miniLockLib.encrypt({
  data: new Blob(["Hello World"]),
  name: 'Secret Greeting.txt'
  keys: {publicKey: Uint8Array, secretKey: Uint8Array},
  miniLockIDs: [aliceID, bobbyID, ...]
  callback: function(error, encrypted) {
    if (encrypted) {
      encrypted.data is a Blob
      encrypted.data.name is 'Secret Greeting.txt.minilock'
      encrypted.data.type is 'application/minilock'
      encrypted.senderID identifies the owner of the encryption keys
    } else {
      error is a String
    }
  }
})

miniLockLib.encrypt accepts the following parameters:

• data is a Blob to be encrypted. An instance of File is also acceptable.
• name specifies the filename as a String.
• keys defines the key pair that will be used to encrypt this file.
• miniLockIDs defines who is permitted to decrypt this file.
• callback should be prepared to receive encrypted.data or an error.

Potential error strings are as follows:

• "Can’t encrypt without a Blob of data."
• "Can’t encrypt without a set of keys."
• "Can’t encrypt without an Array of miniLock IDs."
• "Can’t encrypt because file name is too long. 256-characters max please."
• "Can’t encrypt because media type is too long. 128-characters max please."
• "Can’t encrypt because version X is not supported. Version 1 or 2 please."
• "Failed to encrypt slice of data at [startOfSlice..endOfSlice]"

Unlock a miniLock file. Returns a DecryptOperation.

miniLockLib.decrypt({
  data: encrypted.data,
  keys: {publicKey: Uint8Array, secretKey: Uint8Array},
  callback: function(error, decrypted) {
    if (decrypted) {
      decrypted.data is a Blob
      decrypted.name is the filename as a String
      decrypted.senderID identifies the author of the encrypted file
    } else {
      error is a String
    }
  }
})

miniLockLib.decrypt accepts the following parameters:

• data is a Blob to be decrypted. An instance of File is also acceptable.
• keys defines the key pair that will be used to unlock the file.
• callback is a function that will receive decrypted.data or an error.

Potential error strings are as follows:

• "Can’t decrypt without a Blob of data."
• "Can’t decrypt without a set of keys."
• "Can’t decrypt this file with this set of keys."
• "Failed to decrypt version 1 file attributes."
• "Failed to decrypt version 2 file attributes."
• "Failed to decrypt slice of data at [startOfSlice..endOfSlice]"

SecretPhrase

The secret phrase module supplies an acceptance test to validate secret phrase input.

EmailAddress

The email address module supplies an acceptance test to validate email address input.

ID

The identification module provides functions for encoding (and decoding) miniLock IDs and it also includes an acceptance test to validate ID input.

Encrypt operations make miniLock files.

The constructor accepts data, name, keys and miniLockIDs parameters or you can define them on the operation before you call start.

encryptOperation.start(function(error, decrypted){
  if (decrypted) {
    encrypted.data is a Blob
    encrypted.name is the filename as a String
    encrypted.senderID identifies the author of the encrypted file.
  } else {
    console.error(error)
  }
})

Special Extras

miniLockLib is composed of code from several dandy projects. All of these fine modules are exposed so that you can easily apply their functions in your own computer programs.

Friendly Giants

We send magic seahorses to Dmitry Chestnykh & Nadim Kobeissi everyday. Their ongoing work on tweetnacl-js & miniLock form the core of this library and we are gracious for their heavy lifting.

Other miniLock Projects

miniLock for Google Chrome
File encryption software that does more with less.
From minilock.io

OnionLock for Google Android
Encrypted address book, file transfers and more.
From The Barracks

Deadlock
miniLock encryption for the Python programming language.
From Cathal Garvey