com.hcl.domino.keep.saml

Interface IDVaultAPI

All Superinterfaces:

com.sun.jna.Library

public interface IDVaultAPI
extends com.sun.jna.Library

JNA wrapper for some exported C functions that manipulate SAML assertions and id vault entries. This interface is wrapped by the KeepSAML class, and should not be used directly

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.jna.Library

com.sun.jna.Library.Handler

Field Summary

Fields

Modifier and Type	Field and Description
static IDVaultAPI	INSTANCE requires a platform-specific native library on the PATH e.g., idvaultapi.dll or libidvaultapi.so

Fields inherited from interface com.sun.jna.Library

OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER

Method Summary

Modifier and Type	Method and Description
void	freeUserIdHandle(java.lang.String handle, com.sun.jna.Pointer KFHandle) Free up memory associated with the user id handle
int	getErrorString(short status, com.sun.jna.Memory msgBuf, int bufsize) given a Notes status code, get the associated error string
int	getHostNameFromDN(java.lang.String dn, com.sun.jna.Memory hostName, int bufsize) given a server name in DN format (CN=sansimeon/O=projectkeep.io), fill a buffer with the HTTP host name (https://sansimeon.projectkeep.io) returns the length of the string in the buffer
short	getIDHandle(java.lang.String idFile, com.sun.jna.ptr.LongByReference pbr) Convert an in-memory id file name to a Notes KFHANDLE value (void *)
int	getSAMLRequest(java.lang.String userEmail, java.lang.String dominoName, com.sun.jna.Memory SAMLbuffer, int SAMLbufSize, com.sun.jna.Memory vaultBuffer, int vaultSize) Format a SAML assertion request for the configured IDP given a user email and domino DN.
short	getUserIdHandle(java.lang.String userEmail, java.lang.String dominoName, java.lang.String vaultName, java.lang.String SAMLAssertion, int isB64Encoded, com.sun.jna.Memory idfilebuf, int bufsize) Given a valid SAML assertion XML string, get the handle associated with the user’s ID file

Field Detail

INSTANCE

static final IDVaultAPI INSTANCE

requires a platform-specific native library on the PATH e.g., idvaultapi.dll or libidvaultapi.so

Method Detail

getSAMLRequest

int getSAMLRequest(java.lang.String userEmail,
                   java.lang.String dominoName,
                   com.sun.jna.Memory SAMLbuffer,
                   int SAMLbufSize,
                   com.sun.jna.Memory vaultBuffer,
                   int vaultSize)

Format a SAML assertion request for the configured IDP given a user email and domino DN. Fills in the byte array,

Parameters:

userEmail - xyzzy@google.com or whatever

dominoName - CN=xyzzy/O=org or whatever

SAMLbuffer - returned saml request xml

SAMLbufSize - size of SAMLbuffer in bytes (must be big, say 10KB)

vaultBuffer - returned idvault name

vaultSize - size of vaultBuffer in bytes

Returns:

length in bytes of xml

getUserIdHandle

short getUserIdHandle(java.lang.String userEmail,
                      java.lang.String dominoName,
                      java.lang.String vaultName,
                      java.lang.String SAMLAssertion,
                      int isB64Encoded,
                      com.sun.jna.Memory idfilebuf,
                      int bufsize)

Given a valid SAML assertion XML string, get the handle associated with the user’s ID file

Parameters:

userEmail - xyzzy@google.com or whatever

dominoName - CN=xyzzy/O=org or whatever

vaultName - name returned from getSAMLRequest

SAMLAssertion - assertion response xml

isB64Encoded - should always be true, DO NOT SUBMIT CLEAR TEXT

idfilebuf - returned in-memory file name

bufsize - size of idfilebuf in bytes

Returns:

0 for OK or Notes status code

freeUserIdHandle

void freeUserIdHandle(java.lang.String handle,
                      com.sun.jna.Pointer KFHandle)
               throws com.sun.jna.LastErrorException

Free up memory associated with the user id handle

Parameters:

handle - id file name

Throws:

com.sun.jna.LastErrorException - JNA error

getErrorString

int getErrorString(short status,
                   com.sun.jna.Memory msgBuf,
                   int bufsize)

given a Notes status code, get the associated error string

Parameters:

status - Notes status code

msgBuf - returned error message (generally less than 1KB)

bufsize - size of msgBuf in bytes

Returns:

length of message

getHostNameFromDN

int getHostNameFromDN(java.lang.String dn,
                      com.sun.jna.Memory hostName,
                      int bufsize)

given a server name in DN format (CN=sansimeon/O=projectkeep.io), fill a buffer with the HTTP host name (https://sansimeon.projectkeep.io) returns the length of the string in the buffer

Parameters:

dn - Distinguished name of server

hostName - returned internet host name

bufsize - size of hostName in bytes

Returns:

length of actual hostName, 0 if not found

getIDHandle

short getIDHandle(java.lang.String idFile,
                  com.sun.jna.ptr.LongByReference pbr)

Convert an in-memory id file name to a Notes KFHANDLE value (void *)

Parameters:

idFile - file name

pbr - returned KFHANDLE

Returns:

Notes status