https://github.com/fireblinkltd/fbl-plugins-crypto

FBL file encryption/decryption plugin
https://github.com/fireblinkltd/fbl-plugins-crypto

Last synced: about 1 month ago
JSON representation

FBL file encryption/decryption plugin

• Host: GitHub
• URL: https://github.com/fireblinkltd/fbl-plugins-crypto
• Owner: FireBlinkLTD
• License: mit
• Created: 2019-01-08T09:52:57.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-06T09:12:41.000Z (4 months ago)
• Last Synced: 2024-11-10T01:27:35.939Z (about 1 month ago)
• Language: TypeScript
• Size: 1.65 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# FBL Plugins: Crypto

Encrypt/decrypt files with ease in your [fbl](https://fbl.fireblink.com) flows.

[![Tests](https://github.com/FireBlinkLTD/fbl-plugins-crypto/workflows/Tests/badge.svg)](https://github.com/FireBlinkLTD/fbl-plugins-crypto/actions?query=workflow%3ATests)

[![Known Vulnerabilities](https://snyk.io/test/github/FireBlinkLTD/fbl-plugins-crypto/badge.svg)](https://snyk.io/test/github/FireBlinkLTD/fbl-plugins-crypto)

[![codecov](https://codecov.io/gh/FireBlinkLTD/fbl-plugins-crypto/branch/master/graph/badge.svg)](https://codecov.io/gh/FireBlinkLTD/fbl-plugins-crypto)

[![Total alerts](https://img.shields.io/lgtm/alerts/g/FireBlinkLTD/fbl-plugins-crypto.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/FireBlinkLTD/fbl-plugins-crypto/alerts/)

[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/FireBlinkLTD/fbl-plugins-crypto.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/FireBlinkLTD/fbl-plugins-crypto/context:javascript)

## Integration

There are multiple ways how plugin can be integrated into your flow.

### package.json

This is the most recommended way. Create `package.json` next to your flow file with following content:

```json

{

  "name": "flow-name",

  "version": "1.0.0",

  "description": "",

  "scripts": {

    "fbl": "fbl"

  },

  "license": "UNLICENSED",

  "dependencies": {

    "@fbl-plugins/crypto": "1.1.0",

    "fbl": "1.7.0"

  }

}

```

Then you can install dependencies as any other node module `yarn install` depending on the package manager of your choice.

After that you can use `yarn fbl ` to execute your flow or even register a custom script inside "scripts".

### Global installation

`npm i -g @fbl-plugins/crypto`

### Register plugin to be accessible by fbl

- via cli: `fbl -p @fbl-plugins/crypto `

- via flow:

```yaml

requires:

  fbl: '>=1.7.0'

  plugins:

    '@fbl-plugins/crypto': '>=1.1.0'

pipeline:

  # your flow goes here

```

## Action Handlers

- [encrypt](docs/encrypt.md)

- [decrypt](docs/decrypt.md)

## Template Utilities

- [password generator](docs/templateUtilities.md)