src/charon/plugins/nm/nm_creds.h

   1 /*
   2  * Copyright (C) 2008 Martin Willi
   3  * Hochschule fuer Technik Rapperswil
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; either version 2 of the License, or (at your
   8  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  12  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * for more details.
  14  */
  15
  16 /**
  17  * @defgroup nm_creds nm_creds
  18  * @{ @ingroup nm
  19  */
  20
  21 #ifndef NM_CREDS_H_
  22 #define NM_CREDS_H_
  23
  24 #include <credentials/keys/private_key.h>
  25 #include <credentials/credential_set.h>
  26
  27 typedef struct nm_creds_t nm_creds_t;
  28
  29 /**
  30  * NetworkManager credentials helper.
  31  */
  32 struct nm_creds_t {
  33
  34         /**
  35          * Implements credential_set_t
  36          */
  37         credential_set_t set;
  38
  39         /**
  40          * Set the trusted gateway certificate to serve by this set.
  41          *
  42          * @param cert          certificate to serve
  43          */
  44         void (*set_certificate)(nm_creds_t *this, certificate_t *cert);
  45
  46         /**
  47          * Set the username/password for authentication.
  48          *
  49          * @param id            ID of the user
  50          * @param password      password to use for authentication
  51          */
  52         void (*set_username_password)(nm_creds_t *this, identification_t *id,
  53                                                                   char *password);
  54         /**
  55          * Set the certificate and private key to use for client authentication.
  56          *
  57          * @param cert          client certificate
  58          * @param key           associated private key
  59          */
  60         void (*set_cert_and_key)(nm_creds_t *this, certificate_t *cert,
  61                                                          private_key_t *key);
  62         /**
  63          * Clear the stored credentials.
  64          */
  65         void (*clear)(nm_creds_t *this);
  66
  67         /**
  68          * Destroy a nm_creds instance.
  69          */
  70         void (*destroy)(nm_creds_t *this);
  71 };
  72
  73 /**
  74  * Create a nm_creds instance.
  75  */
  76 nm_creds_t *nm_creds_create();
  77
  78 #endif /** NM_CREDS_H_ @}*/