public final class Secret extends Object implements Serializable
String
that uses encryption in the persisted form, to avoid accidental exposure of a secret.
This is not meant as a protection against code running in the same VM, nor against an attacker who has local file system access on Jenkins master.
Secret
s can correctly read-in plain text password, so this allows the existing
String field to be updated to Secret
.
Modifier and Type | Class and Description |
---|---|
static class |
Secret.ConverterImpl |
Modifier and Type | Method and Description |
---|---|
static Secret |
decrypt(String data)
Reverse operation of
getEncryptedValue() . |
boolean |
equals(Object that) |
static Secret |
fromString(String data)
Attempts to treat the given string first as a cipher text, and if it doesn't work,
treat the given string as the unencrypted secret value.
|
static Cipher |
getCipher(String algorithm)
Workaround for JENKINS-6459 / http://java.net/jira/browse/GLASSFISH-11862
This method uses specific provider selected via hudson.util.Secret.provider system property
to provide a workaround for the above bug where default provide gives an unusable instance.
|
String |
getEncryptedValue()
Encrypts
value and returns it in an encoded printable form. |
String |
getPlainText()
Obtains the plain text password.
|
int |
hashCode() |
String |
toString()
Deprecated.
as of 1.356
Use
toString(Secret) to avoid NPE in case Secret is null.
Or if you really know what you are doing, use the getPlainText() method. |
static String |
toString(Secret s)
Works just like
toString() but avoids NPE when the secret is null. |
public String toString()
toString(Secret)
to avoid NPE in case Secret is null.
Or if you really know what you are doing, use the getPlainText()
method.toString
in class Object
getEncryptedValue()
public String getPlainText()
toString(Secret)
to avoid NPE.public String getEncryptedValue()
value
and returns it in an encoded printable form.toString()
public static Secret decrypt(String data)
getEncryptedValue()
. Returns null
if the given cipher text was invalid.public static Cipher getCipher(String algorithm) throws GeneralSecurityException
GeneralSecurityException
public static Secret fromString(String data)
Useful for recovering a value from a form field.
public static String toString(Secret s)
toString()
but avoids NPE when the secret is null.
To be consistent with fromString(String)
, this method doesn't distinguish
empty password and null password.Copyright © 2014. All rights reserved.