sshgss.h

   1 #define SSH2_GSS_OIDTYPE 0x06
   2 typedef void *Ssh_gss_ctx;
   3 typedef void *Ssh_gss_name;
   4
   5 typedef enum Ssh_gss_stat {
   6     SSH_GSS_OK = 0,
   7     SSH_GSS_S_CONTINUE_NEEDED,
   8     SSH_GSS_NO_MEM,
   9     SSH_GSS_BAD_HOST_NAME,
  10     SSH_GSS_FAILURE
  11 } Ssh_gss_stat;
  12
  13 #define SSH_GSS_S_COMPLETE SSH_GSS_OK
  14
  15 #define SSH_GSS_CLEAR_BUF(buf) do {             \
  16     (*buf).length = 0;                          \
  17     (*buf).value = NULL;                                \
  18 } while (0)
  19
  20 /* Functions, provided by either wingss.c or uxgss.c */
  21
  22 /*
  23  * Do startup-time initialisation for using GSSAPI. (On Windows,
  24  * for instance, this dynamically loads the GSSAPI DLL and
  25  * retrieves some function pointers.)
  26  *
  27  * Return value is 1 on success, or 0 if initialisation failed.
  28  *
  29  * May be called multiple times (since the most convenient place
  30  * to call it _from_ is the ssh.c setup code), and will harmlessly
  31  * return success if already initialised.
  32  */
  33 int ssh_gss_init(void);
  34
  35 /*
  36  * Fills in buf with a string describing the GSSAPI mechanism in
  37  * use. buf->data is not dynamically allocated.
  38  */
  39 Ssh_gss_stat ssh_gss_indicate_mech(Ssh_gss_buf *buf);
  40
  41 /*
  42  * Converts a name such as a hostname into a GSSAPI internal form,
  43  * which is placed in "out". The result should be freed by
  44  * ssh_gss_release_name().
  45  */
  46 Ssh_gss_stat ssh_gss_import_name(char *in, Ssh_gss_name *out);
  47
  48 /*
  49  * Frees the contents of an Ssh_gss_name structure filled in by
  50  * ssh_gss_import_name().
  51  */
  52 Ssh_gss_stat ssh_gss_release_name(Ssh_gss_name *name);
  53
  54 /*
  55  * The main GSSAPI security context setup function. The "out"
  56  * parameter will need to be freed by ssh_gss_free_tok.
  57  */
  58 Ssh_gss_stat ssh_gss_init_sec_context(Ssh_gss_ctx *ctx, Ssh_gss_name name, int delegate,
  59                                       Ssh_gss_buf *in, Ssh_gss_buf *out);
  60
  61 /*
  62  * Frees the contents of an Ssh_gss_buf filled in by
  63  * ssh_gss_init_sec_context(). Do not accidentally call this on
  64  * something filled in by ssh_gss_get_mic() (which requires a
  65  * different free function) or something filled in by any other
  66  * way.
  67  */
  68 Ssh_gss_stat ssh_gss_free_tok(Ssh_gss_buf *);
  69
  70 /*
  71  * Acquires the credentials to perform authentication in the first
  72  * place. Needs to be freed by ssh_gss_release_cred().
  73  */
  74 Ssh_gss_stat ssh_gss_acquire_cred(Ssh_gss_ctx *);
  75
  76 /*
  77  * Frees the contents of an Ssh_gss_ctx filled in by
  78  * ssh_gss_acquire_cred().
  79  */
  80 Ssh_gss_stat ssh_gss_release_cred(Ssh_gss_ctx *);
  81
  82 /*
  83  * Gets a MIC for some input data. "out" needs to be freed by
  84  * ssh_gss_free_mic().
  85  */
  86 Ssh_gss_stat ssh_gss_get_mic(Ssh_gss_ctx ctx, Ssh_gss_buf *in,
  87                              Ssh_gss_buf *out);
  88
  89 /*
  90  * Frees the contents of an Ssh_gss_buf filled in by
  91  * ssh_gss_get_mic(). Do not accidentally call this on something
  92  * filled in by ssh_gss_init_sec_context() (which requires a
  93  * different free function) or something filled in by any other
  94  * way.
  95  */
  96 Ssh_gss_stat ssh_gss_free_mic(Ssh_gss_buf *);
  97
  98 /*
  99  * Return an error message after authentication failed. The
 100  * message string is returned in "buf", with buf->len giving the
 101  * number of characters of printable message text and buf->data
 102  * containing one more character which is a trailing NUL.
 103  * buf->data should be manually freed by the caller.
 104  */
 105 Ssh_gss_stat ssh_gss_display_status(Ssh_gss_ctx, Ssh_gss_buf *buf);