Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Methods](https://developer.android.com/reference/javax/net/ssl/X509KeyManager#pubmethods)

# X509KeyManager


`
public


interface
X509KeyManager
`


`


implements

https://developer.android.com/reference/javax/net/ssl/KeyManager


`

|---|
| javax.net.ssl.X509KeyManager |

|---|
| Known indirect subclasses [X509ExtendedKeyManager](https://developer.android.com/reference/javax/net/ssl/X509ExtendedKeyManager) |---|---| | [X509ExtendedKeyManager](https://developer.android.com/reference/javax/net/ssl/X509ExtendedKeyManager) | Abstract class that provides for extension of the X509KeyManager interface. | |

<br />

*** ** * ** ***

Instances of this interface manage which X509 certificate-based
key pairs are used to authenticate the local side of a secure
socket.


During secure socket negotiations, implentations
call methods in this interface to:

- determine the set of aliases that are available for negotiations based on the criteria presented,
- select the * best alias* based on the criteria presented, and
- obtain the corresponding key material for given aliases.


Note: the X509ExtendedKeyManager should be used in favor of this
class.

## Summary

| ### Public methods ||
|---|---|
| ` abstract https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/javax/net/ssl/X509KeyManager#chooseClientAlias(java.lang.String[],%20java.security.Principal[],%20java.net.Socket)(https://developer.android.com/reference/java/lang/String keyType, https://developer.android.com/reference/java/security/Principal issuers, https://developer.android.com/reference/java/net/Socket socket) ` Choose an alias to authenticate the client side of a secure socket given the public key type and the list of certificate issuer authorities recognized by the peer (if any). |
| ` abstract https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/javax/net/ssl/X509KeyManager#chooseServerAlias(java.lang.String,%20java.security.Principal[],%20java.net.Socket)(https://developer.android.com/reference/java/lang/String keyType, https://developer.android.com/reference/java/security/Principal issuers, https://developer.android.com/reference/java/net/Socket socket) ` Choose an alias to authenticate the server side of a secure socket given the public key type and the list of certificate issuer authorities recognized by the peer (if any). |
| ` abstract https://developer.android.com/reference/java/security/cert/X509Certificate` | ` https://developer.android.com/reference/javax/net/ssl/X509KeyManager#getCertificateChain(java.lang.String)(https://developer.android.com/reference/java/lang/String alias) ` Returns the certificate chain associated with the given alias. |
| ` abstract https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/javax/net/ssl/X509KeyManager#getClientAliases(java.lang.String,%20java.security.Principal[])(https://developer.android.com/reference/java/lang/String keyType, https://developer.android.com/reference/java/security/Principal issuers) ` Get the matching aliases for authenticating the client side of a secure socket given the public key type and the list of certificate issuer authorities recognized by the peer (if any). |
| ` abstract https://developer.android.com/reference/java/security/PrivateKey` | ` https://developer.android.com/reference/javax/net/ssl/X509KeyManager#getPrivateKey(java.lang.String)(https://developer.android.com/reference/java/lang/String alias) ` Returns the key associated with the given alias. |
| ` abstract https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/javax/net/ssl/X509KeyManager#getServerAliases(java.lang.String,%20java.security.Principal[])(https://developer.android.com/reference/java/lang/String keyType, https://developer.android.com/reference/java/security/Principal issuers) ` Get the matching aliases for authenticating the server side of a secure socket given the public key type and the list of certificate issuer authorities recognized by the peer (if any). |

## Public methods

### chooseClientAlias

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public abstract String chooseClientAlias (String[] keyType, 
                Principal[] issuers, 
                Socket socket)
```

Choose an alias to authenticate the client side of a secure
socket given the public key type and the list of
certificate issuer authorities recognized by the peer (if any).

<br />

| Parameters ||
|---|---|
| `keyType` | `String`: the key algorithm type name(s), ordered with the most-preferred key type first. <br /> |
| `issuers` | `Principal`: the list of acceptable CA issuer subject names or null if it does not matter which issuers are used. <br /> |
| `socket` | `Socket`: the socket to be used for this connection. This parameter can be null, which indicates that implementations are free to select an alias applicable to any socket. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the alias name for the desired key, or null if there are no matches. <br /> |

### chooseServerAlias

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public abstract String chooseServerAlias (String keyType, 
                Principal[] issuers, 
                Socket socket)
```

Choose an alias to authenticate the server side of a secure
socket given the public key type and the list of
certificate issuer authorities recognized by the peer (if any).

<br />

| Parameters ||
|---|---|
| `keyType` | `String`: the key algorithm type name. <br /> |
| `issuers` | `Principal`: the list of acceptable CA issuer subject names or null if it does not matter which issuers are used. <br /> |
| `socket` | `Socket`: the socket to be used for this connection. This parameter can be null, which indicates that implementations are free to select an alias applicable to any socket. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the alias name for the desired key, or null if there are no matches. <br /> |

### getCertificateChain

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public abstract X509Certificate[] getCertificateChain (String alias)
```

Returns the certificate chain associated with the given alias.

<br />

| Parameters ||
|---|---|
| `alias` | `String`: the alias name <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/security/cert/X509Certificate` | the certificate chain (ordered with the user's certificate first and the root certificate authority last), or null if the alias can't be found. <br /> |

### getClientAliases

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public abstract String[] getClientAliases (String keyType, 
                Principal[] issuers)
```

Get the matching aliases for authenticating the client side of a secure
socket given the public key type and the list of
certificate issuer authorities recognized by the peer (if any).

<br />

| Parameters ||
|---|---|
| `keyType` | `String`: the key algorithm type name <br /> |
| `issuers` | `Principal`: the list of acceptable CA issuer subject names, or null if it does not matter which issuers are used. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | an array of the matching alias names, or null if there were no matches. <br /> |

### getPrivateKey

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public abstract PrivateKey getPrivateKey (String alias)
```

Returns the key associated with the given alias.

<br />

| Parameters ||
|---|---|
| `alias` | `String`: the alias name <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/security/PrivateKey` | the requested key, or null if the alias can't be found. <br /> |

### getServerAliases

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public abstract String[] getServerAliases (String keyType, 
                Principal[] issuers)
```

Get the matching aliases for authenticating the server side of a secure
socket given the public key type and the list of
certificate issuer authorities recognized by the peer (if any).

<br />

| Parameters ||
|---|---|
| `keyType` | `String`: the key algorithm type name <br /> |
| `issuers` | `Principal`: the list of acceptable CA issuer subject names or null if it does not matter which issuers are used. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | an array of the matching alias names, or null if there were no matches. <br /> |