C# Class minisign.Minisign

Main class to handle minisign files and objects.

Show file Open project: bitbeans/minisign-net

Public Methods

Method	Description
GenerateKeyPair ( string password, bool writeOutputFiles = false, string outputFolder = "", string keyPairFileName = "minisign" ) : MinisignKeyPair	Generate a new Minisign key pair.
LoadPrivateKey ( byte privateKey, byte password ) : MinisignPrivateKey	Load a public key into a MinisignPublicKey object.
LoadPrivateKeyFromFile ( string privateKeyFile, string password ) : MinisignPrivateKey	Load a private key from a file into a MinisignPrivateKey object.
LoadPrivateKeyFromString ( string privateKeyString, string password ) : MinisignPrivateKey	Load a private key from a string into a MinisignPrivateKey object.
LoadPublicKey ( byte publicKey ) : MinisignPublicKey	Load a public key into a MinisignPublicKey object.
LoadPublicKeyFromFile ( string publicKeyFile ) : MinisignPublicKey	Load a public key from a file into a MinisignPublicKey object.
LoadPublicKeyFromString ( string publicKeyString ) : MinisignPublicKey	Load a public key from a string into a MinisignPublicKey object.
LoadSignature ( byte signature, byte trustedComment, byte globalSignature ) : MinisignSignature	Load a signature into a MinisignSignature object.
LoadSignatureFromFile ( string signatureFile ) : MinisignSignature	Load a signature from a file into a MinisignSignature object.
LoadSignatureFromString ( string signatureString, string trustedComment, string globalSignature ) : MinisignSignature	Load a signature from strings into a MinisignSignature object.
Sign ( string fileToSign, MinisignPrivateKey minisignPrivateKey, string untrustedComment = "", string trustedComment = "", string outputFolder = "" ) : string	Sign a file with a MinisignPrivateKey.
ValidateSignature ( byte message, MinisignSignature signature, MinisignPublicKey publicKey ) : bool	Validate a file with a MinisignSignature and a MinisignPublicKey object.
ValidateSignature ( string filePath, MinisignSignature signature, MinisignPublicKey publicKey ) : bool	Validate a file with a MinisignSignature and a MinisignPublicKey object.

Private Methods

Method	Description
GetTimestamp ( ) : int	Get the current Unix Timestamp.
LoadMessageFile ( string messageFile ) : byte[]	Loads a file into memory.

Method Details

GenerateKeyPair() public static method

Generate a new Minisign key pair.

public static GenerateKeyPair ( string password, bool writeOutputFiles = false, string outputFolder = "", string keyPairFileName = "minisign" ) : MinisignKeyPair
password	string	The password to protect the secret key.
writeOutputFiles	bool	If false, no files will be written.
outputFolder	string	The folder to write the files (optional).
keyPairFileName	string	The name of the files to write (optional).
return	minisign.Models.MinisignKeyPair

LoadPrivateKey() public static method

Load a public key into a MinisignPublicKey object.

public static LoadPrivateKey ( byte privateKey, byte password ) : MinisignPrivateKey
privateKey	byte	A valid private key.
password	byte	The password to decrypt the private key.
return	minisign.Models.MinisignPrivateKey

LoadPrivateKeyFromFile() public static method

Load a private key from a file into a MinisignPrivateKey object.

public static LoadPrivateKeyFromFile ( string privateKeyFile, string password ) : MinisignPrivateKey
privateKeyFile	string	The full path to to the private key file.
password	string	The password to decrypt the private key.
return	minisign.Models.MinisignPrivateKey

LoadPrivateKeyFromString() public static method

Load a private key from a string into a MinisignPrivateKey object.

public static LoadPrivateKeyFromString ( string privateKeyString, string password ) : MinisignPrivateKey
privateKeyString	string	A valid Base64 string.
password	string	The password to decrypt the private key.
return	minisign.Models.MinisignPrivateKey

LoadPublicKey() public static method

Load a public key into a MinisignPublicKey object.

public static LoadPublicKey ( byte publicKey ) : MinisignPublicKey
publicKey	byte	A valid public key.
return	minisign.Models.MinisignPublicKey

LoadPublicKeyFromFile() public static method

Load a public key from a file into a MinisignPublicKey object.

public static LoadPublicKeyFromFile ( string publicKeyFile ) : MinisignPublicKey
publicKeyFile	string	The full path to the public key file.
return	minisign.Models.MinisignPublicKey

LoadPublicKeyFromString() public static method

Load a public key from a string into a MinisignPublicKey object.

public static LoadPublicKeyFromString ( string publicKeyString ) : MinisignPublicKey
publicKeyString	string	A valid base64 public key string.
return	minisign.Models.MinisignPublicKey

LoadSignature() public static method

Load a signature into a MinisignSignature object.

public static LoadSignature ( byte signature, byte trustedComment, byte globalSignature ) : MinisignSignature
signature	byte	A valid signature.
trustedComment	byte	The associated trustedComment.
globalSignature	byte	The associated globalSignature.
return	minisign.Models.MinisignSignature

LoadSignatureFromFile() public static method

Load a signature from a file into a MinisignSignature object.

public static LoadSignatureFromFile ( string signatureFile ) : MinisignSignature
signatureFile	string	The full path to the signature file.
return	minisign.Models.MinisignSignature

LoadSignatureFromString() public static method

Load a signature from strings into a MinisignSignature object.

public static LoadSignatureFromString ( string signatureString, string trustedComment, string globalSignature ) : MinisignSignature
signatureString	string	A valid base64 signature string.
trustedComment	string	The associated trusted comment.
globalSignature	string	The associated base64 global signature string.
return	minisign.Models.MinisignSignature

Sign() public static method

Sign a file with a MinisignPrivateKey.

public static Sign ( string fileToSign, MinisignPrivateKey minisignPrivateKey, string untrustedComment = "", string trustedComment = "", string outputFolder = "" ) : string
fileToSign	string	The full path to the file.
minisignPrivateKey	minisign.Models.MinisignPrivateKey	A valid MinisignPrivateKey to sign.
untrustedComment	string	An optional untrusted comment.
trustedComment	string	An optional trusted comment.
outputFolder	string	The folder to write the signature (optional).
return	string

ValidateSignature() public static method

Validate a file with a MinisignSignature and a MinisignPublicKey object.

public static ValidateSignature ( byte message, MinisignSignature signature, MinisignPublicKey publicKey ) : bool
message	byte	The message to validate.
signature	minisign.Models.MinisignSignature	A valid MinisignSignature object.
publicKey	minisign.Models.MinisignPublicKey	A valid MinisignPublicKey object.
return	bool

ValidateSignature() public static method

Validate a file with a MinisignSignature and a MinisignPublicKey object.

public static ValidateSignature ( string filePath, MinisignSignature signature, MinisignPublicKey publicKey ) : bool
filePath	string	The full path to the file.
signature	minisign.Models.MinisignSignature	A valid MinisignSignature object.
publicKey	minisign.Models.MinisignPublicKey	A valid MinisignPublicKey object.
return	bool