Package org.apache.sshd.agent

Class SshAgentKeyConstraint

java.lang.Object

org.apache.sshd.agent.SshAgentKeyConstraint

Direct Known Subclasses:

SshAgentKeyConstraint.Extension, SshAgentKeyConstraint.LifeTime

public abstract class SshAgentKeyConstraint
extends Object

A SshAgentKeyConstraint describes usage constraints for keys when being added to an SSH2 agent.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SshAgentKeyConstraint.Extension	An OpenSSH SshAgentKeyConstraint extension.
static class	SshAgentKeyConstraint.FidoProviderExtension	The OpenSSH "[email protected]" key constraint extension used for FIDO keys.
static class	SshAgentKeyConstraint.LifeTime	An OpenSSH lifetime constraint expires a key added to an SSH agent after the given number of seconds.

Field Summary

Fields

Modifier and Type	Field	Description
static final SshAgentKeyConstraint	CONFIRM	The singleton OpenSSH confirmation SshAgentKeyConstraint.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SshAgentKeyConstraint(byte id)	Constructor setting the agent protocol ID of the constraint.

Method Summary

Modifier and Type	Method	Description
byte	getId()	Retrieves the protocol ID of this constraint.
void	put(Buffer buffer)	Writes this constraint into the given Buffer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CONFIRM

public static final SshAgentKeyConstraint CONFIRM

The singleton OpenSSH confirmation SshAgentKeyConstraint. If set, the SSH agent is supposed to prompt the user before each use of a key in a signing operation.

Users who have this option set via ssh config AddKeysToAgent confirm are responsible themselves for having configured their agent correctly so that it prompts in whatever way is appropriate.

The OpenSSH agent prompts via via ssh-askpass or whatever program the environment variable SSH_ASKPASS defines. These prompts don't go through the prompting callback mechanisms of Apache MINA sshd.

Constructor Details

SshAgentKeyConstraint

protected SshAgentKeyConstraint(byte id)

Constructor setting the agent protocol ID of the constraint.

Parameters:

id - for the key constraint

Method Details

getId

public byte getId()

Retrieves the protocol ID of this constraint.

Returns:

the protocol id of this constraint

put

public void put(Buffer buffer)

Writes this constraint into the given Buffer.

Parameters:

buffer - Buffer to write into at the current buffer write position