Generate Method
Generates a new SSH key.
Syntax
ANSI (Cross Platform) int Generate(const char* lpszKeyAlgorithm, const char* lpszScheme, const char* lpszSchemeParams, int iKeyBits); Unicode (Windows) INT Generate(LPCWSTR lpszKeyAlgorithm, LPCWSTR lpszScheme, LPCWSTR lpszSchemeParams, INT iKeyBits);
- (void)generate:(NSString*)keyAlgorithm :(NSString*)scheme :(NSString*)schemeParams :(int)keyBits;
#define MID_SSHKEYMANAGER_GENERATE 8 SECUREBLACKBOX_EXTERNAL int SECUREBLACKBOX_CALL SecureBlackbox_SSHKeyManager_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);
Remarks
Call this method to generate a new key or keypair with the desired KeyAlgorithmand KeyBits of length.
The generated key will be populated in the Key property.
The KeyAlgorithm parameter supports the following algorithm identifiers:
- RSA
- DSS
- ECDSA
- EDDSA
If using ECDSA, the following curves are supported (to be passed as the Scheme parameter):
- NISTP256
- NISTP384
- NISTP521
- NISTK163
- NISTP192
- NISTP224
- NISTK233
- NISTB233
- NISTK283
- NISTK409
- NISTB409
- NISTK571
The following curves can also be used with EDDSA:
- CURVE25519
- CURVE448
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)