{"id":20597060,"url":"https://github.com/tradle/level-encrypt","last_synced_at":"2025-04-14T23:52:17.699Z","repository":{"id":66294712,"uuid":"57599965","full_name":"tradle/level-encrypt","owner":"tradle","description":"encryption for levelup","archived":false,"fork":false,"pushed_at":"2018-06-09T17:46:28.000Z","size":20,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-14T23:51:53.307Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tradle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-05-01T13:42:29.000Z","updated_at":"2022-11-01T10:08:44.000Z","dependencies_parsed_at":"2023-02-25T22:45:57.058Z","dependency_job_id":null,"html_url":"https://github.com/tradle/level-encrypt","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tradle%2Flevel-encrypt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tradle%2Flevel-encrypt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tradle%2Flevel-encrypt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tradle%2Flevel-encrypt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tradle","download_url":"https://codeload.github.com/tradle/level-encrypt/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248981260,"owners_count":21193144,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T08:20:03.576Z","updated_at":"2025-04-14T23:52:17.690Z","avatar_url":"https://github.com/tradle.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# level-encrypt\n\n*Note: bulk of code originates from [modeler-leveldb](https://github.com/carlos8f/modeler-leveldb).*\n\nEncryption for levelup. Performs necessary hydration/dehydration of JSON objects using [hydration](https://github.com/carlos8f/hydration).\n\n# Usage\n\n```js\nvar crypto = require('crypto')\nvar levelup = require('levelup')\nvar memdown = require('memdown')\nvar encryption = require('level-encrypt')\n\nvar encryptionOptions = {\n  // key derivation parameters\n  saltBytes: 32,\n  digest: 'sha256',\n  keyBytes: 32,\n  // iterations for pbkdf2Sync used to derive the encryption key from the password\n  iterations: 100000,\n  // encryption parameters\n  algorithm:'aes-256-cbc',\n  ivBytes: 16,\n  // tip: this password is crap\n  password: 'oogabooga'\n  // optionally, pass in key instead of password\n  // key: myKeyBuffer\n}\n\n// for custom encryption options, encryptionOptions should look like this:\n// {\n//   encrypt: Function,\n//   decrypt: Function\n// }\n// \n\nvar dbPath = './encrypted.db'\nvar baseDB = levelup(dbPath, {\n  db: memdown\n})\n\nvar db = encryption.toEncrypted(baseDB, encryptionOptions)\nvar key = 'ho'\nvar val = { hey: 'ho' }\ndb.put(key, val, function (err) {\n  if (err) throw err\n\n  db.get(key, function (err, v) {\n    if (err) throw err\n\n    console.log('retrieved plaintext: ' + JSON.stringify(v)) // {\"hey\":ho\"}\n\n    // let's see the ciphertext stored:\n    db.close(function () {\n      baseDB.get(encryption.keyHashFunction(key), function (err, ciphertext) {\n        if (err) throw err\n\n        console.log('stored ciphertext (+ salt + iv): ' + ciphertext.toString('base64'))\n      })\n    })\n  })\n})\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftradle%2Flevel-encrypt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftradle%2Flevel-encrypt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftradle%2Flevel-encrypt/lists"}