vlc_tls.h 7.64 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_tls.h: Transport Layer Security API
3
 *****************************************************************************
4
 * Copyright (C) 2004-2011 Rémi Denis-Courmont
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
5
 * Copyright (C) 2005-2006 VLC authors and VideoLAN
6
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
7 8 9
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
10 11 12 13
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
14 15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
16
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
17 18 19
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
20 21
 *****************************************************************************/

22 23
#ifndef VLC_TLS_H
# define VLC_TLS_H
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
24

25
/**
26 27 28
 * \ingroup sockets
 * \defgroup tls Transport Layer Security
 * @{
29
 * \file
30
 * Transport Layer Security (TLS) functions
31 32
 */

Clément Stenac's avatar
Clément Stenac committed
33
# include <vlc_network.h>
34

35 36 37
typedef struct vlc_tls vlc_tls_t;
typedef struct vlc_tls_creds vlc_tls_creds_t;

38
/** TLS session */
39
struct vlc_tls
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
40
{
41
    vlc_object_t *obj;
42
    void *sys;
43

44
    int (*get_fd)(struct vlc_tls *);
45
    ssize_t (*readv)(struct vlc_tls *, struct iovec *, unsigned);
46
    ssize_t (*writev)(struct vlc_tls *, const struct iovec *, unsigned);
47
    int (*shutdown)(struct vlc_tls *, bool duplex);
48
    void (*close)(struct vlc_tls *);
49 50

    void *p;
51
};
52

53 54 55 56
/**
 * Initiates a client TLS session.
 *
 * Performs client side of TLS handshake through a connected socket, and
57 58
 * establishes a secure channel. This is a blocking network operation and may
 * be a thread cancellation point.
59 60 61 62 63 64 65 66 67 68 69 70 71
 *
 * @param fd socket through which to establish the secure channel
 * @param hostname expected server name, used both as Server Name Indication
 *                 and as expected Common Name of the peer certificate
 * @param service unique identifier for the service to connect to
 *                (only used locally for certificates database)
 * @param alpn NULL-terminated list of Application Layer Protocols
 *             to negotiate, or NULL to not negotiate protocols
 * @param alp storage space for the negotiated Application Layer
 *            Protocol or NULL if negotiation was not performed[OUT]
 *
 * @return TLS session, or NULL on error.
 **/
72
VLC_API vlc_tls_t *vlc_tls_ClientSessionCreate (vlc_tls_creds_t *, int fd,
73 74
                                         const char *host, const char *service,
                                         const char *const *alpn, char **alp);
75

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
/**
 * Creates a TLS server session.
 *
 * Allocates a Transport Layer Security (TLS) session as the server side, using
 * cryptographic keys pair and X.509 certificates chain already loaded with
 * vlc_tls_ServerCreate().
 *
 * Unlike vlc_tls_ClientSessionCreate(), this function does not perform any
 * actual network I/O. vlc_tls_SessionHandshake() must be used to perform the
 * TLS handshake before sending and receiving data through the TLS session.
 *
 * This function is non-blocking and is not a cancellation point.
 *
 * @param creds server credentials, i.e. keys pair and X.509 certificates chain
 * @param alpn NULL-terminated list of Application Layer Protocols
 *             to negotiate, or NULL to not negotiate protocols
 *
 * @return TLS session, or NULL on error.
 */
VLC_API vlc_tls_t *vlc_tls_ServerSessionCreate(vlc_tls_creds_t *creds, int fd,
                                               const char *const *alpn);
97 98

/**
99
 * Destroys a TLS session down.
100
 *
101 102 103 104 105 106
 * All resources associated with the TLS session are released.
 *
 * If the session was established succesfully, then shutdown cleanly, the
 * underlying socket can be reused. Otherwise, it must be closed. Either way,
 * this function does not close the underlying socket: Use vlc_tls_Close()
 * instead to close it at the same.
107 108 109
 *
 * This function is non-blocking and is not a cancellation point.
 */
110
VLC_API void vlc_tls_SessionDelete (vlc_tls_t *);
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
111

112 113 114 115 116
static inline int vlc_tls_GetFD(vlc_tls_t *tls)
{
    return tls->get_fd(tls);
}

117 118 119
/**
 * Receives data through a TLS session.
 */
120
VLC_API ssize_t vlc_tls_Read(vlc_tls_t *, void *buf, size_t len, bool waitall);
121
VLC_API char *vlc_tls_GetLine(vlc_tls_t *);
122 123 124 125

/**
 * Sends data through a TLS session.
 */
126
VLC_API ssize_t vlc_tls_Write(vlc_tls_t *, const void *buf, size_t len);
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
127

128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
/**
 * Terminates a TLS session.
 *
 * This sends the TLS session close notification to the other end, securely
 * indicating that no further data will be sent. Data can still be received
 * until a close notification is received from the other end.
 *
 * @param duplex whether to stop receiving data as well
 * @retval 0 the session was terminated securely and cleanly
 *           (the underlying socket can be reused for other purposes)
 * @return -1 the session was terminated locally, but either a notification
 *            could not be sent or received (the underlying socket cannot be
 *            reused and must be closed)
 */
static inline int vlc_tls_Shutdown(vlc_tls_t *tls, bool duplex)
{
    return tls->shutdown(tls, duplex);
}

147 148
# define tls_Recv(a,b,c) vlc_tls_Read(a,b,c,false)
# define tls_Send(a,b,c) vlc_tls_Write(a,b,c)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
149

150 151 152 153 154 155 156
/**
 * Closes a TLS session and underlying connection.
 *
 * This function is non-blocking and is a cancellation point.
 */
static inline void vlc_tls_Close(vlc_tls_t *session)
{
157
    int fd = vlc_tls_GetFD(session);
158 159 160 161 162 163

    vlc_tls_SessionDelete(session);
    shutdown(fd, SHUT_RDWR);
    net_Close(fd);
}

164
/** TLS credentials (certificate, private and trust settings) */
165
struct vlc_tls_creds
166 167
{
    VLC_COMMON_MEMBERS
168

169
    module_t  *module;
170
    void *sys;
171

172 173 174
    int (*open)(vlc_tls_creds_t *, vlc_tls_t *session, vlc_tls_t *sock,
                const char *host, const char *const *alpn);
    int  (*handshake)(vlc_tls_creds_t *, vlc_tls_t *session, const char *host,
175
                      const char *service, char ** /*restrict*/ alp);
176
};
177

178 179 180 181 182 183
/**
 * Allocates TLS credentials for a client.
 * Credentials can be cached and reused across multiple TLS sessions.
 *
 * @return TLS credentials object, or NULL on error.
 **/
184
VLC_API vlc_tls_creds_t *vlc_tls_ClientCreate (vlc_object_t *);
185 186 187 188

/**
 * Allocates server TLS credentials.
 *
189 190 191
 * @param cert path to an x509 certificate (required)
 * @param key path to the PKCS private key for the certificate,
 *            or NULL to use cert path
192 193 194
 *
 * @return TLS credentials object, or NULL on error.
 */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
195 196 197
VLC_API vlc_tls_creds_t *vlc_tls_ServerCreate (vlc_object_t *,
                                               const char *cert,
                                               const char *key);
198

199 200 201
static inline int vlc_tls_SessionHandshake (vlc_tls_creds_t *crd,
                                            vlc_tls_t *tls)
{
202
    return crd->handshake(crd, tls, NULL, NULL, NULL);
203 204
}

205 206 207 208 209 210 211 212
/**
 * Releases TLS credentials.
 *
 * Releases data allocated with vlc_tls_ClientCreate() or
 * vlc_tls_ServerCreate().
 *
 * @param srv object to be destroyed (or NULL)
 */
213
VLC_API void vlc_tls_Delete (vlc_tls_creds_t *);
214

215
/**
216
 * Creates a transport-layer stream from a socket.
217
 *
218 219
 * Creates a transport-layer I/O stream from a socket file descriptor.
 * Data will be sent and received directly through the socket. This can be used
220 221
 * either to share common code between non-TLS and TLS cases, or for testing
 * purposes.
222 223
 *
 * This function is not a cancellation point.
224
 */
225
VLC_API vlc_tls_t *vlc_tls_SocketOpen(vlc_object_t *obj, int fd);
226

227 228
/** @} */

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
229
#endif