java.lang.Object
- org.keycloak.services.resources.admin.ClientAttributeCertificateResource

public class ClientAttributeCertificateResource
extends Object

Version:: $Revision: 1 $
Author:: Bill Burke

Field Summary

Fields
Modifier and Type	Field	Description
`protected AdminEventBuilder`	`adminEvent`
`protected String`	`attributePrefix`
`static String`	`CERTIFICATE_PEM`
`protected ClientModel`	`client`
`static String`	`JSON_WEB_KEY_SET`
`static String`	`PUBLIC_KEY_PEM`
`protected RealmModel`	`realm`
`protected KeycloakSession`	`session`

Constructor Summary

Constructors
Constructor	Description
`ClientAttributeCertificateResource(AdminPermissionEvaluator auth, ClientModel client, KeycloakSession session, String attributePrefix, AdminEventBuilder adminEvent)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CertificateRepresentation`	`generate()`	Generate a new certificate with new key pair
`byte[]`	`generateAndGetKeystore(KeyStoreConfig config)`	Generate a new keypair and certificate, and get the private key file Generates a keypair and certificate and serves the private key in a specified keystore format.
`CertificateRepresentation`	`getKeyInfo()`	Get key info
`byte[]`	`getKeystore(KeyStoreConfig config)`	Get a keystore file for the client, containing private key and public certificate
`CertificateRepresentation`	`uploadJks()`	Upload certificate and eventually private key
`CertificateRepresentation`	`uploadJksCertificate()`	Upload only certificate, not private key

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

Field Detail

CERTIFICATE_PEM

public static final String CERTIFICATE_PEM

See Also:: Constant Field Values

PUBLIC_KEY_PEM

public static final String PUBLIC_KEY_PEM

See Also:: Constant Field Values

JSON_WEB_KEY_SET

public static final String JSON_WEB_KEY_SET

See Also:: Constant Field Values

realm
```
protected final RealmModel realm
```

client
```
protected final ClientModel client
```

session

protected final KeycloakSession session

adminEvent

protected final AdminEventBuilder adminEvent

attributePrefix
```
protected final String attributePrefix
```

Constructor Detail

ClientAttributeCertificateResource

public ClientAttributeCertificateResource(AdminPermissionEvaluator auth,
                                          ClientModel client,
                                          KeycloakSession session,
                                          String attributePrefix,
                                          AdminEventBuilder adminEvent)

Method Detail

getKeyInfo

@GET
@Produces("application/json")
public CertificateRepresentation getKeyInfo()

Get key info

Returns:

generate

@POST
@Path("generate")
@Produces("application/json")
public CertificateRepresentation generate()

Generate a new certificate with new key pair

Returns:

uploadJks

@POST
@Path("upload")
@Consumes("multipart/form-data")
@Produces("application/json")
public CertificateRepresentation uploadJks()
                                    throws IOException

Upload certificate and eventually private key

Parameters:: input -
Returns:
Throws:: IOException

uploadJksCertificate

@POST
@Path("upload-certificate")
@Consumes("multipart/form-data")
@Produces("application/json")
public CertificateRepresentation uploadJksCertificate()
                                               throws IOException

Upload only certificate, not private key

Parameters:: input -
Returns:: information extracted from uploaded certificate - not necessarily the new state of certificate on the server
Throws:: IOException

getKeystore

@POST
@Path("/download")
@Produces("application/octet-stream")
@Consumes("application/json")
public byte[] getKeystore(KeyStoreConfig config)

Get a keystore file for the client, containing private key and public certificate

Parameters:: config - Keystore configuration as JSON
Returns:

generateAndGetKeystore
```
@POST
@Path("/generate-and-download")
@Produces("application/octet-stream")
@Consumes("application/json")
public byte[] generateAndGetKeystore(KeyStoreConfig config)
```
Generate a new keypair and certificate, and get the private key file Generates a keypair and certificate and serves the private key in a specified keystore format. Only generated public certificate is saved in Keycloak DB - the private key is not.

Parameters:

config - Keystore configuration as JSON

Returns:

Class ClientAttributeCertificateResource