Skip to content

UNLOQIO/loglet-node-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Loglet.io

Loglet.io node.js client for encrypted log streaming and storage.

Introduction

The Loglet.io project uses UNLOQ.io personal encryption keys to generate shared secret keys, used to perform end-to-end encryption (above TLS) from your node.js apps to your browser. In this scenario, the loglet.io servers are working in zero-knowledge state.

Getting Started

Account creation:

Go to https://loglet.io, login with UNLOQ and create an application

Installation:

npm install loglet.io

Usage:

var loglet = require('loglet.io');
loglet({
    key: 'YOUR_APP_KEY',
    secret: 'YOUR_APP_SECRET'
});
/**
 * The log item can contain the following properties:
 *  - name[=default] - the name of the logger or app instance
 *  - namespace[=global] - the namespace of the log event
 *  - level[=debug] - the log level. Values are: trace, debug, info, warn, error, fatal
 *  - message (required) - the message that we want to send.
 *  - data - additional data that can be attached to the log entry as a an object, array, string or number
 *  - tags - additional tags that can be attached to the log entry. Each tag entry must be a string.
 *  - error - additional error information. If we receive an error object, we will also include its stack trace.
 * */
loglet.send({
    level: 'trace',
    message: 'Hello world!'
})

FAQ

  • Q: What data is encrypted?

  • A: By default, the client encrypts the following fields:

  • message

  • data

  • error

  • Q: Can you read any of my logs?

  • A: Our servers work in a zero-knowledge state. That means that the node.js client encrypts the data before it sends it to our API for storage and livestream. The secret key is used to encrypt and decrypt all data, it is never stored in plaintext and we will never have access to it.

  • Q: How can you not have access to the secret key?

  • A: UNLOQ.io offers personal encryption keys for each user. The key is delivered directly in the user's browser and is used by the browser to encrypt all data before it sends it to our servers.

About

Node.js client for loglet.io encrypted log storage

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published