Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixed jsdoc for crypto's decrypt function #257

Merged
merged 4 commits into from
Mar 16, 2018
Merged

Fixed jsdoc for crypto's decrypt function #257

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3b6df31
Fixed jsdoc for crypto's decrypt function
Mar 16, 2018
d9d14b0
Merge branch 'master' into FixCryptoDecryptComment
Mar 16, 2018
c76be7f
Merge branch 'master' into FixCryptoDecryptComment
Mar 16, 2018
6fbd1b1
Merge branch 'FixCryptoDecryptComment' of https://github.com/cumulus-…
Mar 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions packages/ingest/crypto.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ class S3KeyPairProvider {
}

/**
* Decrypt the given string using the given private key stored in the internal bucket
* Decrypt the given string using a private key stored in S3
*
* @param {string} str - The string to encrypt
* @param {string} keyId - The name of the public key to use for encryption
* @param {string} bucket - the optional bucket name. if not provided will
* use env variable "internal"
* @param {stack} stack - the optional stack name. if not provided will
* use env variable "stackName"
* @returns {Promise} the encrypted string
* @param {string} str - The string to decrypt
* @param {string} keyId - The name of the public key to use for decryption
* @param {string} bucket - the optional bucket name. Defaults to the value of
* the "internal" environment variable
* @param {string} stack - the optional stack name. Defaults to the value of
* the "stackName" environment variable
* @returns {Promise.<string>} the decrypted string
*/
static async decrypt(str, keyId = 'private.pem', bucket = null, stack = null) {
const pki = forge.pki;
Expand Down