Package jetbrains.buildServer.ssh

Interface ServerSshKeyManager

All Superinterfaces:

TeamCityExtension

public interface ServerSshKeyManager
extends TeamCityExtension

Field Summary

Fields

Modifier and Type	Field	Description
static String	TEAMCITY_SSH_KEY_PROP

Method Summary

Modifier and Type	Method	Description
TeamCitySshKey	addKey(SProject p, String keyName, byte[] privateKey, ConfigAction configAction)
byte[]	generatePrivateKey(String keyType)	Generates a private key of the specified type.
TeamCitySshKey	getKey(SProject p, String keyName)
List<TeamCitySshKey>	getKeys(SProject p)
List<TeamCitySshKey>	getOwnKeys(SProject p)
Map<SProject,List<TeamCitySshKey>>	getProjectKeys(SProject p)
String	getPublicKey(TeamCitySshKey key)	Retrieves public key of TeamCitySshKey if it is not encrypted.
void	removeKey(SProject p, String keyName, ConfigAction configAction)

Field Detail

TEAMCITY_SSH_KEY_PROP

static final String TEAMCITY_SSH_KEY_PROP

See Also:

Constant Field Values

Method Detail

getKey

@Nullable
TeamCitySshKey getKey(@NotNull
                      SProject p,
                      @NotNull
                      String keyName)

getKeys

@NotNull
List<TeamCitySshKey> getKeys(@NotNull
                             SProject p)

getOwnKeys

@NotNull
List<TeamCitySshKey> getOwnKeys(@NotNull
                                SProject p)

getProjectKeys

@NotNull
Map<SProject,List<TeamCitySshKey>> getProjectKeys(@NotNull
                                                        SProject p)

addKey

@NotNull
TeamCitySshKey addKey(@NotNull
                      SProject p,
                      @NotNull
                      String keyName,
                      @NotNull
                      byte[] privateKey,
                      @NotNull
                      ConfigAction configAction)

removeKey

void removeKey(@NotNull
               SProject p,
               @NotNull
               String keyName,
               @NotNull
               ConfigAction configAction)

generatePrivateKey

@NotNull
byte[] generatePrivateKey(@NotNull
                          String keyType)

Generates a private key of the specified type.

Parameters:

keyType - key type (one of 'ED25519', 'RSA').

Returns:

priveate key

Since:

2023.05

getPublicKey

@NotNull
String getPublicKey(@NotNull
                    TeamCitySshKey key)

Retrieves public key of TeamCitySshKey if it is not encrypted.

Parameters:

key - TeamCity ssh key.

Returns:

a string with key-type and base64-encoded public key.

Since:

2023.05