libssh2/include/libssh2_publickey.h

   1 /* Copyright (c) 2004-2006, Sara Golemon <sarag@libssh2.org>
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms,
   5  * with or without modification, are permitted provided
   6  * that the following conditions are met:
   7  *
   8  *   Redistributions of source code must retain the above
   9  *   copyright notice, this list of conditions and the
  10  *   following disclaimer.
  11  *
  12  *   Redistributions in binary form must reproduce the above
  13  *   copyright notice, this list of conditions and the following
  14  *   disclaimer in the documentation and/or other materials
  15  *   provided with the distribution.
  16  *
  17  *   Neither the name of the copyright holder nor the names
  18  *   of any other contributors may be used to endorse or
  19  *   promote products derived from this software without
  20  *   specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  23  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  24  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  25  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  27  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  29  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  31  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  32  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  33  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  34  * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  35  * OF SUCH DAMAGE.
  36  */
  37
  38 /* Note: This include file is only needed for using the
  39  * publickey SUBSYSTEM which is not the same as publickey
  40  * authentication.  For authentication you only need libssh2.h
  41  *
  42  * For more information on the publickey subsystem,
  43  * refer to IETF draft: secsh-publickey
  44  */
  45
  46 #ifndef LIBSSH2_PUBLICKEY_H
  47 #define LIBSSH2_PUBLICKEY_H 1
  48
  49 typedef struct _LIBSSH2_PUBLICKEY               LIBSSH2_PUBLICKEY;
  50
  51 typedef struct _libssh2_publickey_attribute {
  52     const char *name;
  53     unsigned long name_len;
  54     const char *value;
  55     unsigned long value_len;
  56     char mandatory;
  57 } libssh2_publickey_attribute;
  58
  59 typedef struct _libssh2_publickey_list {
  60     unsigned char *packet; /* For freeing */
  61
  62     const unsigned char *name;
  63     unsigned long name_len;
  64     const unsigned char *blob;
  65     unsigned long blob_len;
  66     unsigned long num_attrs;
  67     libssh2_publickey_attribute *attrs; /* free me */
  68 } libssh2_publickey_list;
  69
  70 /* Generally use the first macro here, but if both name and value are string literals, you can use _fast() to take advantage of preprocessing */
  71 #define libssh2_publickey_attribute(name, value, mandatory)         { (name), strlen(name), (value), strlen(value), (mandatory) },
  72 #define libssh2_publickey_attribute_fast(name, value, mandatory)    { (name), sizeof(name) - 1, (value), sizeof(value) - 1, (mandatory) },
  73
  74 #ifdef __cplusplus
  75 extern "C" {
  76 #endif
  77
  78 /* Publickey Subsystem */
  79 LIBSSH2_API LIBSSH2_PUBLICKEY *libssh2_publickey_init(LIBSSH2_SESSION *session);
  80
  81 LIBSSH2_API int libssh2_publickey_add_ex(LIBSSH2_PUBLICKEY *pkey, const unsigned char *name, unsigned long name_len,
  82                                                             const unsigned char *blob, unsigned long blob_len, char overwrite,
  83                                                             unsigned long num_attrs, const libssh2_publickey_attribute attrs[]);
  84 #define libssh2_publickey_add(pkey, name, blob, blob_len, overwrite, num_attrs, attrs) \
  85         libssh2_publickey_add_ex((pkey), (name), strlen(name), (blob), (blob_len), (overwrite), (num_attrs), (attrs))
  86
  87 LIBSSH2_API int libssh2_publickey_remove_ex(LIBSSH2_PUBLICKEY *pkey, const unsigned char *name, unsigned long name_len,
  88                                                             const unsigned char *blob, unsigned long blob_len);
  89 #define libssh2_publickey_remove(pkey, name, blob, blob_len) \
  90         libssh2_publickey_remove_ex((pkey), (name), strlen(name), (blob), (blob_len))
  91
  92 LIBSSH2_API int libssh2_publickey_list_fetch(LIBSSH2_PUBLICKEY *pkey, unsigned long *num_keys, libssh2_publickey_list **pkey_list);
  93 LIBSSH2_API void libssh2_publickey_list_free(LIBSSH2_PUBLICKEY *pkey, libssh2_publickey_list *pkey_list);
  94
  95 LIBSSH2_API int libssh2_publickey_shutdown(LIBSSH2_PUBLICKEY *pkey);
  96
  97 #ifdef __cplusplus
  98 } /* extern "C" */
  99 #endif
 100
 101 #endif /* ndef: LIBSSH2_PUBLICKEY_H */