ERXCrypto (Project Wonder Reference Documentation)

java.lang.Object
- er.extensions.crypting.ERXCrypto

public class ERXCrypto
extends Object

Provides a wrapper around common encryption and decryption operations. ERXCrypto provides built-in support for DES and Blowfish crypters. You can use the "er.extensions.ERXCrypto.crypters" property to override or provide your own. If you only want DES and/or Blowfish, you don't need to set crypters yourself.

Author:: ?

Properties
Name	Description
`er.extensions.ERXCrypto.default`	the name of the default crypter algorithm (default = "Blowfish")
`er.extensions.ERXCrypto.crypters`	comma-separated list of crypter algorithms (i.e. "DES,Blowfish")
`er.extensions.ERXCrypto.crypter.[Algorithm]`	crypter class name, should be one for each algorithm in crypters list (i.e. er.extensions.ERXCrypto.crypter.DES)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AES` The constant for the AES encryption algorithm.
`static String`	`BLOWFISH` The constant for the Blowfish encryption algorithm.
`static String`	`DES` The constant for the DES encryption algorithm.

Constructor Summary

Constructors
Constructor and Description

ERXCrypto()

Constructors
Constructor and Description
`ERXCrypto()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`algorithmEncode(String text, String algorithmName)` Encodes a given string with a given algorithm.
`static byte[]`	`base64Decode(String s)` Base64 decodes the passed in String
`static String`	`base64Encode(byte[] byteArray)` Base64 encodes the passed in byte[]
`static String`	`base64HashedString(String v)` Uses the SHA hash algorithm found in the Sun JCE to hash the passed in String.
`static String`	`base64urlEncode(byte[] byteArray)` Base64url encodes the passed in byte[]
`static ERXCrypterInterface`	`crypterForAlgorithm(String algorithm)` Returns the crypter for the given algorithm.
`static NSMutableDictionary<String,String>`	`decodedFormValuesDictionary(NSDictionary<String,NSArray<String>> dict)` Decodes all of the values from a given dictionary using the default crypter.
`static ERXCrypterInterface`	`defaultCrypter()` Returns the default crypter.
`static void`	`main(String[] args)` Run this with ERXMainRunner passing in the plaintext you want to encrypt using the default crypter.
`static String`	`md5Encode(String text)` MD5 encodes a given string.
`static void`	`setCrypterForAlgorithm(ERXCrypterInterface crypter, String algorithm)` Sets the crypter for the given algorithm.
`static String`	`sha256Encode(String text)` SHA-256 encodes a given string.
`static String`	`sha384Encode(String text)` SHA-384 encodes a given string.
`static String`	`sha512Encode(String text)` SHA-512 encodes a given string.
`static String`	`shaEncode(String text)` SHA-1 encodes a given string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DES
```
public static final String DES
```
    The constant for the DES encryption algorithm.
    
    See Also:
    
    Constant Field Values
  - BLOWFISH
```
public static final String BLOWFISH
```
    The constant for the Blowfish encryption algorithm.
    
    See Also:
    
    Constant Field Values
  - AES
```
public static final String AES
```
    The constant for the AES encryption algorithm.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ERXCrypto
```
public ERXCrypto()
```
- Method Detail
  - defaultCrypter
```
public static ERXCrypterInterface defaultCrypter()
```
    Returns the default crypter. By default this is Blowfish, but you can override the choice by setting er.extensions.ERXCrypto.default.
    
    Returns:
    
    the default crypter
  - setCrypterForAlgorithm
```
public static void setCrypterForAlgorithm(ERXCrypterInterface crypter,
                                          String algorithm)
```
    Sets the crypter for the given algorithm.
    
    Parameters:
    
    crypter - the crypter to use
    
    algorithm - the algorithm name
  - crypterForAlgorithm
```
public static ERXCrypterInterface crypterForAlgorithm(String algorithm)
```
    Returns the crypter for the given algorithm. By default, DES and Blowfish are available ("DES", "Blowfish", etc).
    
    Parameters:
    
    algorithm - the algorithm to lookup
    
    Returns:
    
    the corresponding crypter
    
    Throws:
    
    IllegalArgumentException - if there is no crypter for the given algorithm
  - decodedFormValuesDictionary
```
public static NSMutableDictionary<String,String> decodedFormValuesDictionary(NSDictionary<String,NSArray<String>> dict)
```
    Decodes all of the values from a given dictionary using the default crypter.
    
    Parameters:
    
    dict - dictionary of key value pairs where the values are encoded strings
    
    Returns:
    
    a dictionary of decoded key-value pairs
  - base64HashedString
```
public static String base64HashedString(String v)
```
    Uses the SHA hash algorithm found in the Sun JCE to hash the passed in String. This String is then base64 encoded and returned.
    
    Parameters:
    
    v - the string to encode
    
    Returns:
    
    the encoded string
  - shaEncode
```
public static String shaEncode(String text)
```
    SHA-1 encodes a given string. The resulting string is safe to use in urls and cookies. From the digest of the string it is nearly impossible to determine what the original string was. Running the same string through the SHA-1 digest multiple times will always produce the same hash.
    
    Parameters:
    
    text - to be put through the sha digest
    
    Returns:
    
    hashed form of the given string
  - sha256Encode
```
public static String sha256Encode(String text)
```
    SHA-256 encodes a given string. The resulting string is safe to use in urls and cookies. From the digest of the string it is nearly impossible to determine what the original string was. Running the same string through the SHA-256 digest multiple times will always produce the same hash.
    
    Parameters:
    
    text - to be put through the sha digest
    
    Returns:
    
    hashed form of the given string
  - sha384Encode
```
public static String sha384Encode(String text)
```
    SHA-384 encodes a given string. The resulting string is safe to use in urls and cookies. From the digest of the string it is nearly impossible to determine what the original string was. Running the same string through the SHA-384 digest multiple times will always produce the same hash.
    
    Parameters:
    
    text - to be put through the sha digest
    
    Returns:
    
    hashed form of the given string
  - sha512Encode
```
public static String sha512Encode(String text)
```
    SHA-512 encodes a given string. The resulting string is safe to use in urls and cookies. From the digest of the string it is nearly impossible to determine what the original string was. Running the same string through the SHA-512 digest multiple times will always produce the same hash.
    
    Parameters:
    
    text - to be put through the sha digest
    
    Returns:
    
    hashed form of the given string
  - md5Encode
```
public static String md5Encode(String text)
```
    MD5 encodes a given string. The resulting string is safe to use in urls and cookies. From the digest of the string it is nearly impossible to determine what the original string was. Running the same string through the MD5 digest multiple times will always produce the same hash.
    
    Parameters:
    
    text - to be put through the sha digest
    
    Returns:
    
    hashed form of the given string
  - algorithmEncode
```
public static String algorithmEncode(String text,
                                     String algorithmName)
```
    Encodes a given string with a given algorithm. The resulting string is safe to use in urls and cookies. From the digest of the string it is nearly impossible to determine what the original string was. Running the same string through the algorithm digest multiple times will always produce the same hash.
    
    Parameters:
    
    text - to be put through the algorithm digest
    
    algorithmName - the algorithm to use (e.g. SHA, SHA-256, ...)
    
    Returns:
    
    hashed form of the given string
  - base64Encode
```
public static String base64Encode(byte[] byteArray)
```
    Base64 encodes the passed in byte[]
    
    Parameters:
    
    byteArray - the byte array to encode
    
    Returns:
    
    the encoded string
  - base64urlEncode
```
public static String base64urlEncode(byte[] byteArray)
```
    Base64url encodes the passed in byte[]
    
    Parameters:
    
    byteArray - the byte array to URL encode
    
    Returns:
    
    the encoded string
  - base64Decode
```
public static byte[] base64Decode(String s)
                           throws IOException
```
    Base64 decodes the passed in String
    
    Parameters:
    
    s - the string to decode
    
    Returns:
    
    a byte array of the decoded string
    
    Throws:
    
    IOException - if the decode fails
  - main
```
public static void main(String[] args)
```
    Run this with ERXMainRunner passing in the plaintext you want to encrypt using the default crypter. This is useful if you are using encrypted properties and you need a quick way to know what to set the property value to.
    
    Parameters:
    
    args - the plaintext to encrypt

Class ERXCrypto

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DES

BLOWFISH

AES

Constructor Detail

ERXCrypto

Method Detail

defaultCrypter

setCrypterForAlgorithm

crypterForAlgorithm

decodedFormValuesDictionary

base64HashedString

shaEncode

sha256Encode

sha384Encode

sha512Encode

md5Encode

algorithmEncode

base64Encode

base64urlEncode

base64Decode

main