SystemCredential

✖
`SystemCredential`

Unsupported in Public Cloud[Experimental]

✖

SystemCredential["keyname"]

gives the expression stored under "keyname" in secure storage.

Details

Expressions can be stored with SystemCredential["keyname"]=expr.
Expressions that can be stored in SystemCredential include:

	"string"	secret string such as password
	SystemCredentialData	general-purpose key-value pairs
	SecuredAuthenticationKey	credentials for an external service

Expressions stored under "keyname" can be removed with Unset[SystemCredential["keyname"]].
SystemCredential uses the operating system's keychain, if possible. If no secure storage is available, it stores its secrets in an encrypted local file.
Under Windows and macOS, the data is by default stored in the default keychain provided.
Under Linux, one of the supported wallet systems can be used.

Examples

open allclose all

Basic Examples (3)Summary of the most common use cases

Store a secret string under the key name "mykey":

In[1]:=1

✖

https://wolfram.com/xid/0btmrb8tw76y-l60bmy

Read the string from secure storage:

In[2]:=2

✖

https://wolfram.com/xid/0btmrb8tw76y-4gxurd

Out[2]=2

Remove the stored data:

In[3]:=3

✖

https://wolfram.com/xid/0btmrb8tw76y-idymwv

Securely store an authentication key:

In[1]:=1

✖

https://wolfram.com/xid/0btmrb8tw76y-sz0f8p

Securely store a record of key-value pairs, with the "Password" field being encrypted:

In[1]:=1

✖

https://wolfram.com/xid/0btmrb8tw76y-l09fgp

Retrieve the stored information:

In[2]:=2

✖

https://wolfram.com/xid/0btmrb8tw76y-5wggox

Out[2]=2

Applications (1)Sample problems that can be solved with this function

Create a SecuredAuthenticationKey with credentials from an external service, the "AuthorizationCode" OAuth 2.0 workflow:

In[1]:=1

✖

https://wolfram.com/xid/0btmrb8tw76y-6msd58

Out[1]=1

Store the key in secure storage:

In[2]:=2

✖

https://wolfram.com/xid/0btmrb8tw76y-elu940

Use the stored key to send signed requests to the service:

In[3]:=3

✖

https://wolfram.com/xid/0btmrb8tw76y-h2eej

Out[3]=3

Properties & Relations (3)Properties of the function, and connections to other functions

List all names of securely stored data:

In[1]:=1

✖

https://wolfram.com/xid/0btmrb8tw76y-8hx0u1

Out[1]=1

Remove stored data for a given key name:

In[1]:=1

✖

https://wolfram.com/xid/0btmrb8tw76y-n5ovha

Remove all stored data:

In[2]:=2

✖

https://wolfram.com/xid/0btmrb8tw76y-pumn82

Use SystemCredentialKey"keyname" to securely store authentication dialog fields between sessions:

In[1]:=1

✖

https://wolfram.com/xid/0btmrb8tw76y-hbf6b

Out[1]=1

The data is remembered in secure storage under the given name:

In[2]:=2

✖

https://wolfram.com/xid/0btmrb8tw76y-ohahtt

Out[2]=2

Possible Issues (1)Common pitfalls and unexpected behavior

Numbers are not accepted by SystemCredential:

In[1]:=1

✖

https://wolfram.com/xid/0btmrb8tw76y-fz7b0

Out[1]=1

Key names must be strings:

In[2]:=2

✖

https://wolfram.com/xid/0btmrb8tw76y-ghpxkf

Out[2]=2

Top