Updated agent plugin to the new builder API
[strongswan.git] / src / libstrongswan / plugins / agent / agent_private_key.h
1 /*
2 * Copyright (C) 2008-2009 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 agent_private_key agent_private_key
18 * @{ @ingroup agent_p
19 */
20
21 #ifndef AGENT_PRIVATE_KEY_H_
22 #define AGENT_PRIVATE_KEY_H_
23
24 #include <credentials/builder.h>
25 #include <credentials/keys/private_key.h>
26
27 typedef struct agent_private_key_t agent_private_key_t;
28
29 /**
30 * private_key_t implementation using an ssh-agent.
31 */
32 struct agent_private_key_t {
33
34 /**
35 * Implements private_key_t interface
36 */
37 private_key_t interface;
38 };
39
40 /**
41 * Open connection to a private key stored in a SSH agent.
42 *
43 * The function takes BUILD_AGENT_SOCKET and optionally a BUILD_PUBLIC_KEY
44 * to select a specific key loaded in ssh-agent.
45 *
46 * @param type type of the key, must be KEY_RSA
47 * @param args builder_part_t argument list
48 * @return built key, NULL on failure
49 */
50 agent_private_key_t *agent_private_key_open(key_type_t type, va_list args);
51
52 #endif /** AGENT_PRIVATE_KEY_H_ @}*/
53