blob: c6fae35537cb8af367b37a3df3527d5535bf9274 [file] [log] [blame]
Elliott Hughescee03382017-06-23 12:17:18 -07001#ifndef HEADER_CURL_RAND_H
2#define HEADER_CURL_RAND_H
3/***************************************************************************
4 * _ _ ____ _
5 * Project ___| | | | _ \| |
6 * / __| | | | |_) | |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
9 *
Elliott Hughes82be86d2017-09-20 17:00:17 -070010 * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
Elliott Hughescee03382017-06-23 12:17:18 -070011 *
12 * This software is licensed as described in the file COPYING, which
13 * you should have received as part of this distribution. The terms
14 * are also available at https://curl.haxx.se/docs/copyright.html.
15 *
16 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17 * copies of the Software, and permit persons to whom the Software is
18 * furnished to do so, under the terms of the COPYING file.
19 *
20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21 * KIND, either express or implied.
22 *
23 ***************************************************************************/
24
25/*
Elliott Hughes82be86d2017-09-20 17:00:17 -070026 * Curl_rand() stores 'num' number of random unsigned characters in the buffer
Elliott Hughescee03382017-06-23 12:17:18 -070027 * 'rnd' points to.
28 *
29 * If libcurl is built without TLS support or with a TLS backend that lacks a
30 * proper random API (Gskit, PolarSSL or mbedTLS), this function will use
31 * "weak" random.
32 *
33 * When built *with* TLS support and a backend that offers strong random, it
34 * will return error if it cannot provide strong random values.
35 *
36 * NOTE: 'data' may be passed in as NULL when coming from external API without
37 * easy handle!
38 *
39 */
Elliott Hughes82be86d2017-09-20 17:00:17 -070040CURLcode Curl_rand(struct Curl_easy *data, unsigned char *rnd, size_t num);
41
42/* Same as above but outputs only random lowercase hex characters.
43 Does NOT terminate.*/
44CURLcode Curl_rand_hex(struct Curl_easy *data, unsigned char *rnd,
45 size_t num);
Elliott Hughescee03382017-06-23 12:17:18 -070046
47#endif /* HEADER_CURL_RAND_H */