Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIStreamCipher Interface Reference

Stream cipher interface. More...

import "nsIStreamCipher.idl";

Inheritance diagram for nsIStreamCipher:
Inheritance graph
[legend]
Collaboration diagram for nsIStreamCipher:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void init (in nsIKeyObject aKey)
 Initialize a stream cipher.
void initWithIV (in nsIKeyObject aKey,[const, array, size_is(aIVLen)] in octet aIV, in unsigned long aIVLen)
 Initialize a stream cipher with an initialization vector.
void update ([const, array, size_is(aLen)] in octet aData, in unsigned long aLen)
 Update from an array of bytes.
void updateFromStream (in nsIInputStream aStream, in long aLen)
 Update from a stream.
void updateFromString (in ACString aInput)
 A more script friendly method (not in nsICryptoHash interface).
ACString finish (in PRBool aASCII)
void discard (in long aLen)
 Discard aLen bytes of the keystream.

Detailed Description

Stream cipher interface.

We're basically copying the interface from nsICryptoHash interface.

Definition at line 45 of file nsIStreamCipher.idl.


Member Function Documentation

Discard aLen bytes of the keystream.

These days 1536 is considered a decent amount to drop to get the key state warmed-up enough for secure usage.

ACString nsIStreamCipher::finish ( in PRBool  aASCII)
Parameters:
aASCIIif true then the returned value is a base-64 encoded string. if false, then the returned value is binary data.

Initialize a stream cipher.

Parameters:
aKeynsIKeyObject
void nsIStreamCipher::initWithIV ( in nsIKeyObject  aKey,
[const, array, size_is(aIVLen)] in octet  aIV,
in unsigned long  aIVLen 
)

Initialize a stream cipher with an initialization vector.

Parameters:
aKeynsIKeyObject
aIVthe initialization vector
aIVLenthe length of the initialization vector
void nsIStreamCipher::update ( [const, array, size_is(aLen)] in octet  aData,
in unsigned long  aLen 
)

Update from an array of bytes.

Update from a stream.

A more script friendly method (not in nsICryptoHash interface).


The documentation for this interface was generated from the following file: