Secret Property

The Base32 encoded shared secret used when creating and validating a password.

Syntax

ANSI (Cross Platform)
char* GetSecret();
int SetSecret(const char* lpszSecret);

Unicode (Windows)
LPWSTR GetSecret();
INT SetSecret(LPCWSTR lpszSecret);
@property (nonatomic,readwrite,assign,getter=secret,setter=setSecret:) NSString* secret;
- (NSString*)secret;
- (void)setSecret:(NSString*)newSecret;

#define PID_TOTP_SECRET 2

IPWORKSAUTH_EXTERNAL void* IPWORKSAUTH_CALL IPWorksAuth_TOTP_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSAUTH_EXTERNAL int IPWORKSAUTH_CALL IPWorksAuth_TOTP_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

This property specifies the Base32 encoded shared secret used when creating and validating a password. This should be set before calling CreatePassword or ValidatePassword.

If this is not set before calling CreatePassword a random secret will be automatically generated. This functionality provides an easy way to create new secret values. The length of the secret is defined by SecretLength.

Data Type

String
Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Auth 2020 C++ Edition - Version 20.0 [Build 8155]