SecureKeys (Apache Brooklyn)

java.lang.Object
- brooklyn.util.crypto.SecureKeysWithoutBouncyCastle
- - brooklyn.util.crypto.SecureKeys

```
public class SecureKeys
extends SecureKeysWithoutBouncyCastle
```
Utility methods for generating and working with keys, extending the parent class with useful things provided by BouncyCastle crypto library. (Parent class is in a different project where BC is not included as a dependency.)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SecureKeys.PassphraseProblem

Nested Classes
Modifier and Type	Class and Description
`static class`	`SecureKeys.PassphraseProblem`

Method Summary

Methods
Modifier and Type	Method and Description
`static boolean`	`equal(java.security.KeyPair k1, java.security.KeyPair k2)` because KeyPair.equals is not implemented :(
`static java.security.PublicKey`	`fromPub(java.lang.String pubText)` opposite of `toPub(KeyPair)`, given text
`static org.bouncycastle.jce.X509Principal`	`getX509PrincipalWithCommonName(java.lang.String commonName)` RFC1773 order, with None for other values.
`static void`	`initBouncyCastleProvider()`
`static java.security.KeyPair`	`readPem(java.io.InputStream input, java.lang.String passphrase)` reads RSA or DSA / pem style private key files (viz `toPem(KeyPair)`), extracting also the public key if possible
`static java.lang.String`	`stringPem(java.security.KeyPair key)` Deprecated. since 0.7.0, use `toPem(KeyPair)`
`static java.lang.String`	`toPem(java.security.KeyPair key)` returns the PEM (base64, ie for id_rsa) string for the private key / key pair; this starts -----BEGIN PRIVATE KEY----- and ends similarly, like id_rsa.
`static java.lang.String`	`toPub(java.security.KeyPair key)` returns id_rsa.pub style file, of public key

Methods inherited from class brooklyn.util.crypto.SecureKeysWithoutBouncyCastle
getCanonicalImpl, getTrustManager, getTrustManager, getTrustManager, getX500PrincipalWithCommonName, isCertificateAuthorizedBy, newKeyPair, newKeyPair, newKeyPairGenerator, newKeyStore, newKeyStore

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

- Method Detail
  - initBouncyCastleProvider
```
public static void initBouncyCastleProvider()
```
  - getX509PrincipalWithCommonName
```
public static org.bouncycastle.jce.X509Principal getX509PrincipalWithCommonName(java.lang.String commonName)
```
    RFC1773 order, with None for other values. Normally prefer X500Principal.
  - readPem
```
public static java.security.KeyPair readPem(java.io.InputStream input,
                            java.lang.String passphrase)
```
    reads RSA or DSA / pem style private key files (viz toPem(KeyPair)), extracting also the public key if possible
    
    Throws:
    
    java.lang.IllegalStateException - on errors, in particular SecureKeys.PassphraseProblem if that is the problem
  - equal
```
public static boolean equal(java.security.KeyPair k1,
            java.security.KeyPair k2)
```
    because KeyPair.equals is not implemented :(
  - toPem
```
public static java.lang.String toPem(java.security.KeyPair key)
```
    returns the PEM (base64, ie for id_rsa) string for the private key / key pair; this starts -----BEGIN PRIVATE KEY----- and ends similarly, like id_rsa. also see readPem(InputStream, String)
  - toPub
```
public static java.lang.String toPub(java.security.KeyPair key)
```
    returns id_rsa.pub style file, of public key
  - fromPub
```
public static java.security.PublicKey fromPub(java.lang.String pubText)
```
    opposite of toPub(KeyPair), given text
  - stringPem
```
@Deprecated
public static java.lang.String stringPem(java.security.KeyPair key)
```
    Deprecated. since 0.7.0, use toPem(KeyPair)

Class SecureKeys

Nested Class Summary

Method Summary

Methods inherited from class brooklyn.util.crypto.SecureKeysWithoutBouncyCastle

Methods inherited from class java.lang.Object

Method Detail

initBouncyCastleProvider

getX509PrincipalWithCommonName

readPem

equal

toPem

toPub

fromPub

stringPem