ConfidentialKey (Jenkins core 2.401.3 API)

java.lang.Object
- jenkins.security.ConfidentialKey

Direct Known Subclasses:

CryptoConfidentialKey, HexStringConfidentialKey, HMACConfidentialKey, RSAConfidentialKey
```
public abstract class ConfidentialKey
extends Object
```
Confidential information that gets stored as a singleton in Jenkins, mostly some random token value.
The actual value is persisted via ConfidentialStore, but each use case that requires a secret like this should use a separate ConfidentialKey instance so that one compromised ConfidentialKey (say through incorrect usage and failure to protect it) shouldn't compromise all the others.
ConfidentialKey is ultimately a sequence of bytes, but for convenience, a family of subclasses are provided to represent the secret in different formats. See HexStringConfidentialKey and HMACConfidentialKey for example. In addition to the programming ease, these use case specific subtypes make it harder for vulnerability to creep in by making it harder for the secret to leak.
The ConfidentialKey subtypes are expected to be used as a singleton, like JnlpAgentReceiver.SLAVE_SECRET. For code that relies on XStream for persistence (such as Builders, SCMs, and other fragment objects around builds and jobs), Secret provides more convenient way of storing secrets.

Since:

1.498

Author:

Kohsuke Kawaguchi

See Also:

Secret

- Constructor Summary
  
  Constructors
  Modifier Constructor Description
  
  protected ConfidentialKey(String id)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  String getId()
  
  protected byte[] load()
  
  protected void store(byte[] payload)
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfidentialKey

protected ConfidentialKey(String id)

Method Detail

load

@CheckForNull
protected byte[] load()
               throws IOException

Throws:: IOException

store

protected void store(byte[] payload)
              throws IOException

Throws:: IOException

getId
```
public String getId()
```