{"_id":"@credenceanalytics/aws-kms-adaptor","_rev":"5-a4e11b9f5782624c7281744380531d84","name":"@credenceanalytics/aws-kms-adaptor","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@credenceanalytics/aws-kms-adaptor","version":"1.0.0","_id":"@credenceanalytics/aws-kms-adaptor@1.0.0","maintainers":[{"name":"prabhuvikas","email":"vikasprabhu@credenceanalytics.com"},{"name":"jimmyjammerx","email":"pratiksatardekar@credenceanalytics.com"},{"name":"suraj_chavan","email":"surajchavan@credenceanalytics.com"},{"name":"cred-shubham","email":"shubhamyadav@credenceanalytics.com"},{"name":"mohinim18","email":"mohinimemane@credenceanalytics.com"},{"name":"jiteshsuthar","email":"jiteshsuthar@credenceanalytics.com"},{"name":"mandakadam","email":"mandakadam@credenceanalytics.com"},{"name":"prajaktacred","email":"prajaktashinde@credenceanalytics.com"},{"name":"sagarf","email":"sagarfernandes@credenceanalytics.com"},{"name":"atulknowsme","email":"atulpal@credenceanalytics.com"},{"name":"shruti_shende","email":"shrutishende@credenceanalytics.com"},{"name":"sonalnadkar","email":"sonalnadkar@credenceanalytics.com"}],"dist":{"shasum":"4a2bbcad7eb5498c531433b40fe4ce3ab7815565","tarball":"https://registry.npmjs.org/@credenceanalytics/aws-kms-adaptor/-/aws-kms-adaptor-1.0.0.tgz","fileCount":4,"integrity":"sha512-LpDfCYaMID0aH/dy3Sw2izRUBKSI4CfxLz988hVMJTr0g6mej2nAAAbxumwiYj5A/alJpr0vBkENwRpkSpCY+w==","signatures":[{"sig":"MEYCIQD+EBjMCiecD00AjJZ2MnL+4gwF7kUKXOSUkU5W2rT6/gIhALFqQS0TsKLxf2kLp8f7oRVgfX1RfGW3OMldSk43A00y","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":9326},"main":"index.js","gitHead":"7da1f9230984e929495852f3a5477cbbe7bafdc3","scripts":{"test":"jest /test/aws.test.js"},"_npmUser":{"name":"jimmyjammerx","email":"pratiksatardekar@credenceanalytics.com"},"repository":{"url":"https://gitlab.credenceanalytics.com/frameworks-and-tools/aws-kms-adaptor.git","type":"git"},"_npmVersion":"9.6.7","description":"This package contains the code for aws kms ","directories":{},"_nodeVersion":"18.17.1","dependencies":{"npm":"^10.9.0","jest":"^29.7.0","install":"^0.13.0","@aws-crypto/client-node":"^4.0.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/aws-kms-adaptor_1.0.0_1735278234976_0.42917849919007556","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2024-12-27T05:43:54.884Z","modified":"2026-09-21T10:50:33.015Z","1.0.0":"2024-12-27T05:43:55.134Z"},"repository":{"url":"https://gitlab.credenceanalytics.com/frameworks-and-tools/aws-kms-adaptor.git","type":"git"},"description":"This package contains the code for aws kms ","maintainers":[{"email":"vikasprabhu@credenceanalytics.com","name":"prabhuvikas"},{"email":"surajchavan@credenceanalytics.com","name":"suraj_chavan"},{"email":"mohinimemane@credenceanalytics.com","name":"mohinim18"},{"email":"jiteshsuthar@credenceanalytics.com","name":"jiteshsuthar"},{"email":"mandakadam@credenceanalytics.com","name":"mandakadam"},{"email":"sonalnadkar@credenceanalytics.com","name":"sonalnadkar"},{"email":"suhassurwase@credenceanalytics.com","name":"suhas_surwase"}],"readme":"# AWS KMS Adaptor\r\n## Installation    \r\n-   Execute below mentioned command:\r\n    ```\r\n    npm install @credenceanalytics/aws-kms-adaptor\r\n    ``` \r\n----\r\n\r\n### Requirements\r\n-   **AWS SDK**: Ensure AWS credentials are properly configured for KMS access.\r\n-   **Dependencies**: This library internally uses `@aws-crypto/client-node`.\r\n\r\n----------\r\n\r\n## Usage\r\n\r\n### Initialization\r\n\r\nImport and initialize the AWS KMS Adaptor with your AWS configuration:\r\n```\r\n`const AwskmsInstance = require('aws-kms-adaptor');\r\n const kmsAdaptor = new AwskmsInstance(<awsconfig>);` \r\n```\r\n---------\r\n### Encrypt Data\r\n```\r\nconst plaintext = 'Sensitive information';\r\nkmsAdaptor.encryptDataAndReturn(<plaintext>).then((encryptedData) => {\r\n  console.log('Encrypted Data:', encryptedData);\r\n}).catch((error) => {\r\n  console.error('Encryption Error:', error.message);\r\n});\r\n```\r\n----------\r\n### Decrypt Data\r\n\r\n```\r\nconst encryptedData = '<Base64-encoded encrypted data>';\r\nkmsAdaptor.decryptData(encryptedData).then((decryptedData) => {\r\n  console.log('Decrypted Data:', decryptedData);\r\n}).catch((error) => {\r\n  console.error('Decryption Error:', error.message);\r\n});\r\n```\r\n-------------\r\n## Configuration\r\n\r\n-   **AWS Key ARN**: The `kms_key_Arn` parameter specifies the KMS key used for encryption and decryption.\r\n-   **Encryption Context**: Default context includes metadata for purpose and environment. You can customize it in the `encryptionContext` field inside the class.\r\n\r\n----------\r\n\r\nFeel free to modify this template further to fit your project's specific needs.","readmeFilename":"README.md"}