User-friendly AngularJS encryption module utilizing the Web Cryptography API and providing an extensible secure secret storage mechanism.
npm install aenigmaUser-friendly AngularJS encryption module utilizing the Web Cryptography API and providing an extensible secure secret storage mechanism.
Install through npm:
``
npm install --save aenigma
Then include in your apps module:
`typescript
import { NgModule } from '@angular/core';
import { AenigmaModule } from 'aenigma';
@NgModule({
imports: [
AenigmaModule.forRoot()
]
})
export class MyModule {}
`
Finally use in one of your apps components:
`typescript
import { Component } from '@angular/core';
@Component({
template: '
})
export class MyComponent {}
`
You may also find it useful to view the demo source.
html
`Usage
$3
typescript
@NgModule({
imports: [
AenigmaModule.forRoot()
],
providers: [
AenigmaLocalStorageProvider
]
})
`$3
typescript
constructor(private _encryptedStorageProvider: AenigmaLocalStorageProvider) { }
`$3
typescript
constructor(private _encryptedStorageProvider: AenigmaLocalStorageProvider) { Aenigma.create().subscribe(
(aenigma: Aenigma) => {
this._aenigma = aenigma;
},
error => {
console.error(error);
}
);
}
`$3
typescript
constructor(private _encryptedStorageProvider: AenigmaLocalStorageProvider) { Aenigma.create().subscribe(
(aenigma: Aenigma) => {
this._aenigma = aenigma;
this._encryptedStorage = new AenigmaStorageService(
this._aenigma,
this._encryptedStorageProvider
);
},
error => {
console.error(error);
}
);
}
`$3
typescript
this._aenigma
.encrypt(plaintext)
.subscribe((encrypted: EncryptedValue) => {
console.log(encrypted.stringify());
});
`typescript
this._aenigma
.decrypt(EncryptedValue.parse(cipher))
.subscribe((decrypted: string) => {
this._plaintext = decrypted;
});
`$3
typescript
this._encryptedStorage
.store('supersecret', 'secret_id')
.subscribe((encrypted: EncryptedValue) => {
console.log(encrypted.stringify());
});
`typescript
this._encryptedStorage
.retrieve('secret_id')
.subscribe((plaintext: string) => {
console.log(plaintext);
});
`Development
$3
Install Node.js and NPM
Install local dev dependencies:
while current directory is this repo$3
Run
npm start to start a development server on port 8000 with auto reload + tests.$3
Run
npm test to run tests once or npm run test:watch` to continually run tests.Library and API documentation is available at https://armintamzarian.github.io/aenigma/
* Initial Release
(The MIT License)
Copyright (c) 2017 Armin Tamzarian
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.