An open API service indexing awesome lists of open source software.

https://github.com/commenthol/ansible-vault

An ansible vault compatible en- and decryption library for node
https://github.com/commenthol/ansible-vault

Last synced: over 1 year ago
JSON representation

An ansible vault compatible en- and decryption library for node

Awesome Lists containing this project

README

          

[![NPM version](https://img.shields.io/npm/v/ansible-vault) ![npm](https://img.shields.io/npm/dm/ansible-vault)](https://www.npmjs.com/package/ansible-vault/)
[![Build Status](https://github.com/commenthol/ansible-vault/actions/workflows/ci.yml/badge.svg)](https://github.com/commenthol/ansible-vault/actions/workflows/ci.yml)

# ansible-vault

> An Ansible vault compatible en- and decryption library for javascript

## usage

encrypt

```js
import { Vault } from 'ansible-vault'

const v = new Vault({ password: 'pa$$w0rd' })
v.encrypt('superSecret123').then(console.log)
//> $ANSIBLE_VAULT;1.1;AES256
//> 33383239333036363833303565653032383832663162356533343630623030613133623032636566
//> 6536303436646561356461623866386133623462383832620a646363626137626635353462386430
//> 34333937313366383038346135656563316236313139333933383139376333353266666436316536
//> 6335376265313432610a313537363637383264646261303637646631346137393964386432313633
//> 3666

// or for synchronous operation
const vault = v.encryptSync('superSecret123')
```

decrypt

```js
import { Vault } from 'ansible-vault'

const vault = `$ANSIBLE_VAULT;1.1;AES256
33383239333036363833303565653032383832663162356533343630623030613133623032636566
6536303436646561356461623866386133623462383832620a646363626137626635353462386430
34333937313366383038346135656563316236313139333933383139376333353266666436316536
6335376265313432610a313537363637383264646261303637646631346137393964386432313633
3666`

const v = new Vault({ password: 'pa$$w0rd' })
v.decrypt(vault).then(console.log)
//> superSecret123

// or for synchronous operation
const secret = v.decryptSync(vault)
```

## license

MIT Licensed

## references

* [vault-source][vault-source]

[vault-source]: https://github.com/ansible/ansible/blob/devel/lib/ansible/parsing/vault/__init__.py

[Ansible®](https://docs.ansible.com/ansible/latest/dev_guide/style_guide/trademarks.html) is a registered trademark of [RedHat®](https://www.redhat.com/en) (I hope this is correct...)