summaryrefslogtreecommitdiff
path: root/librabbitmq/amqp-ssl.h
blob: 17cbcc17047e2cec39400773afbeadcbcac0fe4d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
/*
 * Copyright 2012 Michael Steinert
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

/**
 * \file
 * Open an SSL/TLS connection
 */

#ifndef AMQP_SSL_H
#define AMQP_SSL_H

#include <amqp.h>

/**
 * Open an SSL connection to an AMQP broker.
 *
 * This function will setup an AMQP connection state object for SSL/TLS
 * communication. The caller of this function should not use the returned
 * file descriptor as input to amqp_set_sockfd() or amqp_set_sockfd_full(),
 * or directly for network I/O.
 *
 * If a client key or certificate file is provide then they should both be
 * provided.
 *
 * \param [in,out] state An AMQP connection state object.
 * \param [in] host The name of the host to connect to.
 * \param [in] port The port to connect on.
 * \param [in] caert Path the CA cert file in PEM format.
 * \param [in] key Path to the client key in PEM format. (may be NULL)
 * \param [in] cert Path to the client cert in PEM format. (may be NULL)
 *
 * \return A socket file-descriptor (-1 if an error occurred).
 */
AMQP_PUBLIC_FUNCTION
int
amqp_open_ssl_socket(amqp_connection_state_t state,
		     const char *host,
		     int port,
		     const char *cacert,
		     const char *key,
		     const char *cert);

#endif /* AMQP_SSL_H */