[Contents] [Index]

About This Document>>     Introduction to SSH Secure Shell >>     Configuring SSH Secure Shell >>     Authentication >>         Server Authentication>>         User Authentication>>         Keyboard-Interactive Authentication >>             Overview             Configuring the Server and Client             Adding New Authentication Methods >>                 init Type                 free Type                 SshKbdIntSubMethodCB Type                 SshKbdIntSubMethodConv Type     Log Messages >>     Using SSH Secure Shell >>     Tool Syntax>>     Technical Specifications >>

SshKbdIntSubMethodConv Type

Synopsis

typedef void (*SshKbdIntSubMethodConv)(SshKbdIntResult code,
    const char *instruction,
    size_t num_reqs,
    char **reqs,
    Boolean *echo,
    SshKbdIntSubMethodCB method_cb,
    void *method_ctx,
    void *context);

Description

The submethod calls this function when it has the requests.

Arguments

code

Indicates the state of the authentication. If the submethod authentication is a success, this should be SSH_KBDINT_SUBMETHOD_RESULT_SUCCESS, if failed, SSH_KBDINT_SUBMETHOD_RESULT_FAILED, and if the authentication is not complete, SSH_KBDINT_SUBMETHOD_RESULT_NONE_YET.

instruction

This field should contain a short description of what the user should do.

num_reqs

Indicates the size of reqs and echo arrays. If the code is not SSH_KBDINT_SUBMETHOD_RESULT_NONE_YET, this should be 0, and reqs and echo should be NULL.

reqs

The requests sent to the client.

echo

Tells the client whether the user's response to the corresponding request should be echoed.

method_cb

The main method will call this when it has obtained the responses from the client.

method_ctx

This is given to method_cb by the main method.

context

The allocated context.

[Contents] [Index]