com.microsoft.aad.msal4jextensions.persistence.linux

Interface ISecurityLibrary

All Superinterfaces:

com.sun.jna.Library

public interface ISecurityLibrary
extends com.sun.jna.Library

Interface which represents API for libsecret library on Linux. It is used for storing and retrieving passwords and other secrets on Linux. It communicates with the "Secret Service" using D-Bus https://developer.gnome.org/libsecret/0.18/

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 ISecurityLibrary	library

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_SYMBOL_PROVIDER, OPTION_TYPE_MAPPER

Method Summary

Modifier and Type	Method and Description
int	secret_password_clear_sync(com.sun.jna.Pointer schema, com.sun.jna.Pointer cancellable, com.sun.jna.Pointer[] error, String attribute1Key, String attribute1Value, String attribute2Key, String attribute2Value, com.sun.jna.Pointer end) Remove unlocked matching passwords from the secret service
String	secret_password_lookup_sync(com.sun.jna.Pointer schema, com.sun.jna.Pointer cancellable, com.sun.jna.Pointer[] error, String attribute1Key, String attribute1Value, String attribute2Key, String attribute2Value, com.sun.jna.Pointer end) Lookup a password in the secret service
int	secret_password_store_sync(com.sun.jna.Pointer schema, String collection, String label, String password, com.sun.jna.Pointer cancellable, com.sun.jna.Pointer[] error, String attribute1Key, String attribute1Value, String attribute2Key, String attribute2Value, com.sun.jna.Pointer end) Store a password in the secret service
com.sun.jna.Pointer	secret_schema_new(String name, int flag, String attribute1Key, int attribute1Type, String attribute2Key, int attribute2Type, com.sun.jna.Pointer end) Creates a schema for saving secret, it represents a set of attributes that are stored with it

Field Detail

library

static final ISecurityLibrary library

Method Detail

secret_schema_new

com.sun.jna.Pointer secret_schema_new(String name,
                                      int flag,
                                      String attribute1Key,
                                      int attribute1Type,
                                      String attribute2Key,
                                      int attribute2Type,
                                      com.sun.jna.Pointer end)

Creates a schema for saving secret, it represents a set of attributes that are stored with it

Parameters:

name - Name of the schema

flag - The flag for the schema definition SecretSchemaFlags

attribute1Key - Name/Key of the attribute1 of the schema

attribute1Type - Type of the attribute1 of the schema SecretSchemaAttributeType

attribute2Key - Name/Key of the attribute2 of the schema

attribute2Type - Type of the attribute2 of the schema SecretSchemaAttributeType

end - Null parameter to indicate end of attributes

Returns:

A schema for saving and retrieving secret

secret_password_store_sync

int secret_password_store_sync(com.sun.jna.Pointer schema,
                               String collection,
                               String label,
                               String password,
                               com.sun.jna.Pointer cancellable,
                               com.sun.jna.Pointer[] error,
                               String attribute1Key,
                               String attribute1Value,
                               String attribute2Key,
                               String attribute2Value,
                               com.sun.jna.Pointer end)

Store a password in the secret service

Parameters:

schema - Schema for attributes

collection - A collection alias, or D-Bus object path of the collection where to store the secret

label - Label for the secret

password - The secret to save

cancellable - Optional cancellation object

error - Location to place an error on failure

attribute1Key - Key of the attribute1

attribute1Value - Value of the attribute1

attribute2Key - Key of the attribute2

attribute2Value - Value of the attribute2

end - Null parameter to indicate end of attributes

Returns:

Whether the storage was successful or not

secret_password_lookup_sync

String secret_password_lookup_sync(com.sun.jna.Pointer schema,
                                   com.sun.jna.Pointer cancellable,
                                   com.sun.jna.Pointer[] error,
                                   String attribute1Key,
                                   String attribute1Value,
                                   String attribute2Key,
                                   String attribute2Value,
                                   com.sun.jna.Pointer end)

Lookup a password in the secret service

Parameters:

schema - The schema for the attributes

cancellable - Optional cancellation object

error - Location to place an error on failure

attribute1Key - Key of the attribute1

attribute1Value - Value of the attribute1

attribute2Key - Key of the attribute2

attribute2Value - Value of the attribute2

end - Null parameter to indicate end of attributes

Returns:

The retrieved secret

secret_password_clear_sync

int secret_password_clear_sync(com.sun.jna.Pointer schema,
                               com.sun.jna.Pointer cancellable,
                               com.sun.jna.Pointer[] error,
                               String attribute1Key,
                               String attribute1Value,
                               String attribute2Key,
                               String attribute2Value,
                               com.sun.jna.Pointer end)

Remove unlocked matching passwords from the secret service

Parameters:

schema - The schema for the attributes

cancellable - Optional cancellation object

error - Location to place an error on failure

attribute1Key - Key of the attribute1

attribute1Value - Value of the attribute1

attribute2Key - Key of the attribute2

attribute2Value - Value of the attribute2

end - Null parameter to indicate end of attributes

Returns:

Whether the any passwords were removed