goog.storage.EncryptedStorage

Provided By	`goog.storage.EncryptedStorage`
Extends	`goog.storage.CollectableStorage` `goog.storage.ExpiringStorage` `goog.storage.RichStorage` `goog.storage.Storage`

Provides an encrypted storage. The keys are hashed with a secret, so their existence cannot be verified without the knowledge of the secret. The values are encrypted using the key, a salt, and the secret, so stream cipher initialization varies for each stored value.

new EncryptedStorage( `mechanism`, `secret` )

Parameters

`mechanism`	`goog.storage.mechanism.IterableMechanism`
	The underlying storage mechanism.
`secret`	`string`
	The secret key used to encrypt the storage.

VIEW SOURCE

Instance Methods

Cleans up the storage by removing expired keys.

Defined by

goog.storage.CollectableStorage

Parameters

`opt_strict`	`boolean=`
	Also remove invalid keys.

VIEW SOURCE

Cleans up the storage by removing expired keys.

Defined by

goog.storage.CollectableStorage

Parameters

`keys`	`({length: number}\|{__iterator__: ?})`
	List of all keys.
`opt_strict`	`boolean=`
	Also remove invalid keys.

Returns

Array<string>

a list of expired keys.

VIEW SOURCE

Gets an item from the data storage.

Defined by

goog.storage.RichStorage

Overrides

goog.storage.Storage

Parameters

`key`	`string`
	The key to get.

Returns

*

Deserialized value or undefined if not found.

VIEW SOURCE

Get an item wrapper (the item and its metadata) from the storage.

Overrides

goog.storage.ExpiringStorage

Parameters

`key`	`string`
	The key to get.
`opt_expired`	`boolean=`
	If true, return expired wrappers as well.

Returns

(Object|undefined)

The wrapper, or undefined if not found.

VIEW SOURCE

Removes an item from the data storage.

Overrides

goog.storage.Storage

Parameters

`key`	`string`
	The key to remove.

VIEW SOURCE

Set an item in the storage.

Overrides

goog.storage.ExpiringStorage

Parameters

`key`	`string`
	The key to set.
`value`	`*`
	The value to serialize to a string and save.
`opt_expiration`	`number=`
	The number of miliseconds since epoch (as in goog.now()) when the value is to expire. If the expiration time is not provided, the value will persist as long as possible.

VIEW SOURCE

Instance Properties

The mechanism used to persist key-value pairs.

VIEW SOURCE

Static Properties

Metadata key under which the salt is stored.

VIEW SOURCE

goog.storage.EncryptedStorage

new EncryptedStorage( `mechanism`, `secret` )

Instance Methods

`this.`collect( `opt_strict` ) `→` `void`

`this.`collectInternal( `keys`, `opt_strict` ) `→` `Array<string>`

`this.`get( `key` ) `→` `*`

`this.`getWrapper( `key`, `opt_expired` ) `→` `(Object|undefined)`

`this.`remove( `key` ) `→` `void`

`this.`set( `key`, `value`, `opt_expiration` ) `→` `void`

Instance Properties

`this.`mechanism `→` `(goog.storage.mechanism.Mechanism|null)`

Static Properties

EncryptedStorage.SALT_KEY `→` `string`

goog.storage.EncryptedStorage

new EncryptedStorage( mechanism, secret )

Instance Methods

this.collect( opt_strict ) → void

this.collectInternal( keys, opt_strict ) → Array<string>

this.get( key ) → *

this.getWrapper( key, opt_expired ) → (Object|undefined)

this.remove( key ) → void

this.set( key, value, opt_expiration ) → void

Instance Properties

this.mechanism → (goog.storage.mechanism.Mechanism|null)

Static Properties

EncryptedStorage.SALT_KEY → string

new EncryptedStorage( `mechanism`, `secret` )

`this.`collect( `opt_strict` ) `→` `void`

`this.`collectInternal( `keys`, `opt_strict` ) `→` `Array<string>`

`this.`get( `key` ) `→` `*`

`this.`getWrapper( `key`, `opt_expired` ) `→` `(Object|undefined)`

`this.`remove( `key` ) `→` `void`

`this.`set( `key`, `value`, `opt_expiration` ) `→` `void`

`this.`mechanism `→` `(goog.storage.mechanism.Mechanism|null)`

EncryptedStorage.SALT_KEY `→` `string`