# Secure storage modules

###### Identifier:

org.eclipse.equinox.security.secureStorage

###### Description:

Describes implementation of the Equinox secure storage module.

###### Configuration Markup:

<!ELEMENT extension (provider)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #REQUIRED

name CDATA #IMPLIED>

<!ELEMENT provider (hint*)>

<!ATTLIST provider

class CDATA #REQUIRED

priority CDATA #REQUIRED

description CDATA #IMPLIED

obsoletes CDATA #IMPLIED>

- class - Class implementing password provider interface. The class must extend the `org.eclipse.equinox.security.storage.provider.PasswordProvider` class.
- priority - The integer number 0 to 10 describing priority of this password provider, with 0 being the lowest priority. Newly created secure preferences will use the password provider with the highest priority. If multiple providers have the same priority, an arbitrary provider among them will be selected.
- description - Optional text describing to the user functionality of this password provider.
- obsoletes - Full id of any old secure storage provider this extension obsoletes.

<!ELEMENT hint EMPTY>

<!ATTLIST hint

value (AutomaticPasswordGeneration) >

- value - To help secure storage optimize workflows, providers that acquire master passwords without input from the user the should specify `AutomaticPasswordGeneration` hint.

###### Examples:

       <extension
             id="custom"
             point="org.eclipse.equinox.security.secureStorage">
          <provider
                class="com.xyz.PasswordProvider"
                priority="7">
          </provider>
       </extension>

###### API Information:

[Enter API information here.]

###### Supplied Implementation:

The `org.eclipse.equinox.security.ui` bundle supplies default password provider that prompts user to enter the password.

The `org.eclipse.equinox.security.win32` fragment provides Windows OS integration.

The `org.eclipse.equinox.security.linux` fragment provides Linux OS integration.

The `org.eclipse.equinox.security.macosx` fragment provides Mac OS integration.

Copyright (c) 2008 IBM Corporation and others.
This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html/ SPDX-License-Identifier: EPL-2.0