CkCsp Java Reference Documentation

CkCsp

Current Version: 9.5.0.75

Represents a cryptographic service provider for selecting encryption, hashing, and digital signing algorithms.

This class is specific to the Windows operating system, and therefore is only available on Windows systems.

Object Creation

CkCsp obj = new CkCsp();

Properties

DebugLogFilePath
void get_DebugLogFilePath(CkString str);
String debugLogFilePath();
void put_DebugLogFilePath(String newVal);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
EncryptAlgorithm
void get_EncryptAlgorithm(CkString str);
String encryptAlgorithm();

Returns the name of the currently selected encryption algorithm in the currently selected CSP.

top
EncryptAlgorithmID
int get_EncryptAlgorithmID();

Returns the ID of the currently selected encryption algorithm in the currently selected CSP.

top
EncryptNumBits
int get_EncryptNumBits();

Returns the key-length of the currently selected encryption algorithm in the currently selected CSP.

top
HashAlgorithm
void get_HashAlgorithm(CkString str);
String hashAlgorithm();

Returns the name of the currently selected hash algorithm in the currently selected CSP.

top
HashAlgorithmID
int get_HashAlgorithmID();

Returns the ID of the currently selected hash algorithm in the currently selected CSP.

top
HashNumBits
int get_HashNumBits();

Returns the bit length of the currently selected hash algorithm in the currently selected CSP.

top
KeyContainerName
void get_KeyContainerName(CkString str);
String keyContainerName();
void put_KeyContainerName(String newVal);

The name of the currently selected key container within the currently selected CSP. The default is typically the name of the current logged-in user.

top
LastErrorHtml
void get_LastErrorHtml(CkString str);
String lastErrorHtml();

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
void get_LastErrorText(CkString str);
String lastErrorText();

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
void get_LastErrorXml(CkString str);
String lastErrorXml();

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
boolean get_LastMethodSuccess();
void put_LastMethodSuccess(boolean newVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
MachineKeyset
boolean get_MachineKeyset();
void put_MachineKeyset(boolean newVal);

To be documented soon.

top
NumEncryptAlgorithms
int get_NumEncryptAlgorithms();

The number of encryption algorithms provided by the currently selected CSP.

top
NumHashAlgorithms
int get_NumHashAlgorithms();

The number of hash algorithms provided by the currently selected CSP.

top
NumKeyContainers
int get_NumKeyContainers();

The number of key containers provided by the currently selected CSP.

top
NumKeyExchangeAlgorithms
int get_NumKeyExchangeAlgorithms();

The number of key exchange algorithms provided by the currently selected CSP.

top
NumSignatureAlgorithms
int get_NumSignatureAlgorithms();

The number of signature algorithms provided by the currently selected CSP.

top
ProviderName
void get_ProviderName(CkString str);
String providerName();
void put_ProviderName(String newVal);

The currently selected CSP. To select another CSP, simply set this property to the name of the CSP, such as "Microsoft Enhanced Cryptographic Provider v1.0". If the CSP is not available on your machine, the property value will not change. The initial and default value for this property is "Microsoft Base Cryptographic Provider v1.0".

top
ProviderType
int get_ProviderType();

This is an integer representing the type of CSP. (Chilkat uses it for internal use.)

top
VerboseLogging
boolean get_VerboseLogging();
void put_VerboseLogging(boolean newVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
void get_Version(CkString str);
String version();

Version of the component/library, such as "9.5.0.63"

top

Methods

GetKeyContainerNames
CkStringArray GetKeyContainerNames();

To be documented soon...

Returns nil on failure

top
HasEncryptAlgorithm
boolean HasEncryptAlgorithm(String name, int numBits);

Returns true if the currently selected CSP contains an encryption algorithm matching the name and key length. Otherwise returns false.

top
HasHashAlgorithm
boolean HasHashAlgorithm(String name, int numBits);

Returns true if the currently selected CSP contains a hash algorithm matching the name and bit length. Otherwise returns false.

top
Initialize
boolean Initialize();

Intializes the Csp with the selected ProviderName.

top
NthEncryptionAlgorithm
boolean NthEncryptionAlgorithm(int index, CkString outStr);
String nthEncryptionAlgorithm(int index);

Returns the name of the Nth encryption algorithm provided by the currently selected CSP. Indexing begins at 0.

Returns true for success, false for failure.

top
NthEncryptionNumBits
int NthEncryptionNumBits(int index);

Returns the key-length of the currently selected encryption algorithm in the currently selected CSP.

top
NthHashAlgorithmName
boolean NthHashAlgorithmName(int index, CkString outStr);
String nthHashAlgorithmName(int index);

To be documented soon...

Returns true for success, false for failure.

top
NthHashNumBits
int NthHashNumBits(int index);

Returns the bit length of the Nth hash algorithm provided by the currently selected CSP. Indexing begins at 0.

top
NthKeyContainerName
boolean NthKeyContainerName(int index, CkString outStr);
String nthKeyContainerName(int index);

Returns the Nth key container name in the currently selected CSP. Indexing begins at 0.

Returns true for success, false for failure.

top
NthKeyExchangeAlgorithm
boolean NthKeyExchangeAlgorithm(int index, CkString outStr);
String nthKeyExchangeAlgorithm(int index);

Returns the Nth key exchange algorithm provided by the currently selected CSP. Indexing begins at 0.

Returns true for success, false for failure.

top
NthKeyExchangeNumBits
int NthKeyExchangeNumBits(int index);

Returns the bit length of the Nth key exchange algorithm provided by the currently selected CSP. Indexing begins at 0.

top
NthSignatureAlgorithm
boolean NthSignatureAlgorithm(int index, CkString outStr);
String nthSignatureAlgorithm(int index);

Returns the name of the Nth signature algorithm provided by the currently selected CSP. Indexing begins at 0.

Returns true for success, false for failure.

top
NthSignatureNumBits
int NthSignatureNumBits(int index);

Returns the bit length of the Nth signature algorithm provided by the currently selected CSP. Indexing begins at 0.

top
SaveLastError
boolean SaveLastError(String path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

top
SetEncryptAlgorithm
int SetEncryptAlgorithm(String name);

Selects an encryption algorithm. The return value is the key-length of the algorithm. If the algorithm is not available, the return value is 0. (There usually is not a need to explicitly select the key length, because the key length can be part of the name, such as "AES 128", or it is determined by the CSP. For example, the Microsoft Enhanced CSP will return a 128-bit key length for RC2, whereas the Base CSP will return a 40-bit key length.)

top
SetHashAlgorithm
int SetHashAlgorithm(String name);

Selects a hash algorithm. The return value is the bit-length of the algorithm. If the algorithm is not available, the return value is 0.

top
SetProviderMicrosoftBase
boolean SetProviderMicrosoftBase();

Sets the CSP to the Base Microsoft Cryptographic Provider, which is the default.

top
SetProviderMicrosoftEnhanced
boolean SetProviderMicrosoftEnhanced();

Sets the CSP to the Enhanced Microsoft Cryptographic Provider.

top
SetProviderMicrosoftRsaAes
boolean SetProviderMicrosoftRsaAes();

Sets the CSP to the Microsoft Cryptographic RSA/AES Prototype Provider.

top
SetProviderMicrosoftStrong
boolean SetProviderMicrosoftStrong();

Sets the CSP to the Strong Microsoft Cryptographic Provider.

top