您最多选择25个主题 主题必须以字母或数字开头,可以包含连字符 (-),并且长度不得超过35个字符

Factor out the buffering and low-level record code. This begins decoupling the transport from the SSL state machine. The buffering logic is hidden behind an opaque API. Fields like ssl->packet and ssl->packet_length are gone. ssl3_get_record and dtls1_get_record now call low-level tls_open_record and dtls_open_record functions that unpack a single record independent of who owns the buffer. Both may be called in-place. This removes ssl->rstate which was redundant with the buffer length. Future work will push the buffer up the stack until it is above the handshake. Then we can expose SSL_open and SSL_seal APIs which act like *_open_record but return a slightly larger enum due to other events being possible. Likewise the handshake state machine will be detached from its buffer. The existing SSL_read, SSL_write, etc., APIs will be implemented on top of SSL_open, etc., combined with ssl_read_buffer_* and ssl_write_buffer_*. (Which is why ssl_read_buffer_extend still tries to abstract between TLS's and DTLS's fairly different needs.) The new buffering logic does not support read-ahead (removed previously) since it lacks a memmove on ssl_read_buffer_discard for TLS, but this could be added if desired. The old buffering logic wasn't quite right anyway; it tried to avoid the memmove in some cases and could get stuck too far into the buffer and not accept records. (The only time the memmove is optional is in DTLS or if enough of the record header is available to know that the entire next record would fit in the buffer.) The new logic also now actually decrypts the ciphertext in-place again, rather than almost in-place when there's an explicit nonce/IV. (That accidentally switched in https://boringssl-review.googlesource.com/#/c/4792/; see 3d59e04bce96474099ba76786a2337e99ae14505.) BUG=468889 Change-Id: I403c1626253c46897f47c7ae93aeab1064b767b2 Reviewed-on: https://boringssl-review.googlesource.com/5715 Reviewed-by: Adam Langley <agl@google.com>
9 年前
Tighten up EMS resumption behaviour. The client and server both have to decide on behaviour when resuming a session where the EMS state of the session doesn't match the EMS state as exchanged in the handshake. Original handshake | No Yes ------+-------------------------------------------------------------- | R | Server: ok [1] Server: abort [3] e No | Client: ok [2] Client: abort [4] s | u | m | e | Yes | Server: don't resume No problem | Client: abort; server | shouldn't have resumed [1] Servers want to accept legacy clients. The draft[5] says that resumptions SHOULD be rejected so that Triple-Handshake can't be done, but we'll rather enforce that EMS was used when using tls-unique etc. [2] The draft[5] says that even the initial handshake should be aborted if the server doesn't support EMS, but we need to be able to talk to the world. [3] This is a very weird case where a client has regressed without flushing the session cache. Hopefully we can be strict and reject these. [4] This can happen when a server-farm shares a session cache but frontends are not all updated at once. If Chrome is strict here then hopefully we can prevent any servers from existing that will try to resume an EMS session that they don't understand. OpenSSL appears to be ok here: https://www.ietf.org/mail-archive/web/tls/current/msg16570.html [5] https://tools.ietf.org/html/draft-ietf-tls-session-hash-05#section-5.2 BUG=492200 Change-Id: Ie1225a3960d49117b05eefa5a36263d8e556e467 Reviewed-on: https://boringssl-review.googlesource.com/4981 Reviewed-by: Adam Langley <agl@google.com>
9 年前
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051
  1. /* ssl/ssl.h */
  2. /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
  3. * All rights reserved.
  4. *
  5. * This package is an SSL implementation written
  6. * by Eric Young (eay@cryptsoft.com).
  7. * The implementation was written so as to conform with Netscapes SSL.
  8. *
  9. * This library is free for commercial and non-commercial use as long as
  10. * the following conditions are aheared to. The following conditions
  11. * apply to all code found in this distribution, be it the RC4, RSA,
  12. * lhash, DES, etc., code; not just the SSL code. The SSL documentation
  13. * included with this distribution is covered by the same copyright terms
  14. * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15. *
  16. * Copyright remains Eric Young's, and as such any Copyright notices in
  17. * the code are not to be removed.
  18. * If this package is used in a product, Eric Young should be given attribution
  19. * as the author of the parts of the library used.
  20. * This can be in the form of a textual message at program startup or
  21. * in documentation (online or textual) provided with the package.
  22. *
  23. * Redistribution and use in source and binary forms, with or without
  24. * modification, are permitted provided that the following conditions
  25. * are met:
  26. * 1. Redistributions of source code must retain the copyright
  27. * notice, this list of conditions and the following disclaimer.
  28. * 2. Redistributions in binary form must reproduce the above copyright
  29. * notice, this list of conditions and the following disclaimer in the
  30. * documentation and/or other materials provided with the distribution.
  31. * 3. All advertising materials mentioning features or use of this software
  32. * must display the following acknowledgement:
  33. * "This product includes cryptographic software written by
  34. * Eric Young (eay@cryptsoft.com)"
  35. * The word 'cryptographic' can be left out if the rouines from the library
  36. * being used are not cryptographic related :-).
  37. * 4. If you include any Windows specific code (or a derivative thereof) from
  38. * the apps directory (application code) you must include an acknowledgement:
  39. * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40. *
  41. * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44. * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51. * SUCH DAMAGE.
  52. *
  53. * The licence and distribution terms for any publically available version or
  54. * derivative of this code cannot be changed. i.e. this code cannot simply be
  55. * copied and put under another distribution licence
  56. * [including the GNU Public Licence.]
  57. */
  58. /* ====================================================================
  59. * Copyright (c) 1998-2007 The OpenSSL Project. All rights reserved.
  60. *
  61. * Redistribution and use in source and binary forms, with or without
  62. * modification, are permitted provided that the following conditions
  63. * are met:
  64. *
  65. * 1. Redistributions of source code must retain the above copyright
  66. * notice, this list of conditions and the following disclaimer.
  67. *
  68. * 2. Redistributions in binary form must reproduce the above copyright
  69. * notice, this list of conditions and the following disclaimer in
  70. * the documentation and/or other materials provided with the
  71. * distribution.
  72. *
  73. * 3. All advertising materials mentioning features or use of this
  74. * software must display the following acknowledgment:
  75. * "This product includes software developed by the OpenSSL Project
  76. * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  77. *
  78. * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  79. * endorse or promote products derived from this software without
  80. * prior written permission. For written permission, please contact
  81. * openssl-core@openssl.org.
  82. *
  83. * 5. Products derived from this software may not be called "OpenSSL"
  84. * nor may "OpenSSL" appear in their names without prior written
  85. * permission of the OpenSSL Project.
  86. *
  87. * 6. Redistributions of any form whatsoever must retain the following
  88. * acknowledgment:
  89. * "This product includes software developed by the OpenSSL Project
  90. * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  91. *
  92. * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  93. * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  94. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  95. * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
  96. * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  97. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  98. * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  99. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  100. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  101. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  102. * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  103. * OF THE POSSIBILITY OF SUCH DAMAGE.
  104. * ====================================================================
  105. *
  106. * This product includes cryptographic software written by Eric Young
  107. * (eay@cryptsoft.com). This product includes software written by Tim
  108. * Hudson (tjh@cryptsoft.com).
  109. *
  110. */
  111. /* ====================================================================
  112. * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
  113. * ECC cipher suite support in OpenSSL originally developed by
  114. * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
  115. */
  116. /* ====================================================================
  117. * Copyright 2005 Nokia. All rights reserved.
  118. *
  119. * The portions of the attached software ("Contribution") is developed by
  120. * Nokia Corporation and is licensed pursuant to the OpenSSL open source
  121. * license.
  122. *
  123. * The Contribution, originally written by Mika Kousa and Pasi Eronen of
  124. * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
  125. * support (see RFC 4279) to OpenSSL.
  126. *
  127. * No patent licenses or other rights except those expressly stated in
  128. * the OpenSSL open source license shall be deemed granted or received
  129. * expressly, by implication, estoppel, or otherwise.
  130. *
  131. * No assurances are provided by Nokia that the Contribution does not
  132. * infringe the patent or other intellectual property rights of any third
  133. * party or that the license provides you with all the necessary rights
  134. * to make use of the Contribution.
  135. *
  136. * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
  137. * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
  138. * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
  139. * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
  140. * OTHERWISE.
  141. */
  142. #ifndef OPENSSL_HEADER_SSL_H
  143. #define OPENSSL_HEADER_SSL_H
  144. #include <openssl/base.h>
  145. #include <openssl/bio.h>
  146. #include <openssl/buf.h>
  147. #include <openssl/hmac.h>
  148. #include <openssl/lhash.h>
  149. #include <openssl/pem.h>
  150. #include <openssl/thread.h>
  151. #include <openssl/x509.h>
  152. #if !defined(OPENSSL_WINDOWS)
  153. #include <sys/time.h>
  154. #endif
  155. /* wpa_supplicant expects to get the version functions from ssl.h */
  156. #include <openssl/crypto.h>
  157. /* Forward-declare struct timeval. On Windows, it is defined in winsock2.h and
  158. * Windows headers define too many macros to be included in public headers.
  159. * However, only a forward declaration is needed. */
  160. struct timeval;
  161. #if defined(__cplusplus)
  162. extern "C" {
  163. #endif
  164. /* SSL implementation. */
  165. /* Initialization. */
  166. /* SSL_library_init initializes the crypto and SSL libraries and returns one. */
  167. OPENSSL_EXPORT int SSL_library_init(void);
  168. /* Cipher suites. */
  169. /* An SSL_CIPHER represents a cipher suite. */
  170. typedef struct ssl_cipher_st {
  171. /* name is the OpenSSL name for the cipher. */
  172. const char *name;
  173. /* id is the cipher suite value bitwise OR-d with 0x03000000. */
  174. uint32_t id;
  175. /* The following are internal fields. See ssl/internal.h for their values. */
  176. uint32_t algorithm_mkey;
  177. uint32_t algorithm_auth;
  178. uint32_t algorithm_enc;
  179. uint32_t algorithm_mac;
  180. uint32_t algorithm_ssl;
  181. uint32_t algo_strength;
  182. uint32_t algorithm_prf;
  183. /* strength_bits is the strength of the cipher in bits. */
  184. int strength_bits;
  185. /* alg_bits is the number of bits of key material used by the algorithm. */
  186. int alg_bits;
  187. } SSL_CIPHER;
  188. DECLARE_STACK_OF(SSL_CIPHER)
  189. /* SSL_get_cipher_by_value returns the structure representing a TLS cipher
  190. * suite based on its assigned number, or NULL if unknown. See
  191. * https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4. */
  192. OPENSSL_EXPORT const SSL_CIPHER *SSL_get_cipher_by_value(uint16_t value);
  193. /* SSL_CIPHER_get_id returns |cipher|'s id. It may be cast to a |uint16_t| to
  194. * get the cipher suite value. */
  195. OPENSSL_EXPORT uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *cipher);
  196. /* SSL_CIPHER_is_AES returns one if |cipher| uses AES (either GCM or CBC
  197. * mode). */
  198. OPENSSL_EXPORT int SSL_CIPHER_is_AES(const SSL_CIPHER *cipher);
  199. /* SSL_CIPHER_has_MD5_HMAC returns one if |cipher| uses HMAC-MD5. */
  200. OPENSSL_EXPORT int SSL_CIPHER_has_MD5_HMAC(const SSL_CIPHER *cipher);
  201. /* SSL_CIPHER_is_AESGCM returns one if |cipher| uses AES-GCM. */
  202. OPENSSL_EXPORT int SSL_CIPHER_is_AESGCM(const SSL_CIPHER *cipher);
  203. /* SSL_CIPHER_is_CHACHA20POLY1305 returns one if |cipher| uses
  204. * CHACHA20_POLY1305. */
  205. OPENSSL_EXPORT int SSL_CIPHER_is_CHACHA20POLY1305(const SSL_CIPHER *cipher);
  206. /* SSL_CIPHER_get_name returns the OpenSSL name of |cipher|. */
  207. OPENSSL_EXPORT const char *SSL_CIPHER_get_name(const SSL_CIPHER *cipher);
  208. /* SSL_CIPHER_get_kx_name returns a string that describes the key-exchange
  209. * method used by |cipher|. For example, "ECDHE_ECDSA". */
  210. OPENSSL_EXPORT const char *SSL_CIPHER_get_kx_name(const SSL_CIPHER *cipher);
  211. /* SSL_CIPHER_get_rfc_name returns a newly-allocated string with the standard
  212. * name for |cipher| or NULL on error. For example,
  213. * "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256". The caller is responsible for
  214. * calling |OPENSSL_free| on the result. */
  215. OPENSSL_EXPORT char *SSL_CIPHER_get_rfc_name(const SSL_CIPHER *cipher);
  216. /* SSL_CIPHER_get_bits returns the strength, in bits, of |cipher|. If
  217. * |out_alg_bits| is not NULL, it writes the number of bits consumed by the
  218. * symmetric algorithm to |*out_alg_bits|. */
  219. OPENSSL_EXPORT int SSL_CIPHER_get_bits(const SSL_CIPHER *cipher,
  220. int *out_alg_bits);
  221. /* SSL contexts. */
  222. /* An SSL_METHOD selects whether to use TLS or DTLS. */
  223. typedef struct ssl_method_st SSL_METHOD;
  224. /* TLS_method is the |SSL_METHOD| used for TLS (and SSLv3) connections. */
  225. OPENSSL_EXPORT const SSL_METHOD *TLS_method(void);
  226. /* DTLS_method is the |SSL_METHOD| used for DTLS connections. */
  227. OPENSSL_EXPORT const SSL_METHOD *DTLS_method(void);
  228. /* SSL_CTX_new returns a newly-allocated |SSL_CTX| with default settings or NULL
  229. * on error. An |SSL_CTX| manages shared state and configuration between
  230. * multiple TLS or DTLS connections. */
  231. OPENSSL_EXPORT SSL_CTX *SSL_CTX_new(const SSL_METHOD *method);
  232. /* SSL_CTX_free releases memory associated with |ctx|. */
  233. OPENSSL_EXPORT void SSL_CTX_free(SSL_CTX *ctx);
  234. /* SSL connections. */
  235. /* SSL_new returns a newly-allocated |SSL| using |ctx| or NULL on error. An
  236. * |SSL| object represents a single TLS or DTLS connection. It inherits settings
  237. * from |ctx| at the time of creation. Settings may also be individually
  238. * configured on the connection.
  239. *
  240. * On creation, an |SSL| is not configured to be either a client or server. Call
  241. * |SSL_set_connect_state| or |SSL_set_accept_state| to set this. */
  242. OPENSSL_EXPORT SSL *SSL_new(SSL_CTX *ctx);
  243. /* SSL_free releases memory associated with |ssl|. */
  244. OPENSSL_EXPORT void SSL_free(SSL *ssl);
  245. /* SSL_set_connect_state configures |ssl| to be a client. */
  246. OPENSSL_EXPORT void SSL_set_connect_state(SSL *ssl);
  247. /* SSL_set_accept_state configures |ssl| to be a server. */
  248. OPENSSL_EXPORT void SSL_set_accept_state(SSL *ssl);
  249. /* Protocol versions. */
  250. #define DTLS1_VERSION_MAJOR 0xfe
  251. #define SSL3_VERSION_MAJOR 0x03
  252. #define SSL3_VERSION 0x0300
  253. #define TLS1_VERSION 0x0301
  254. #define TLS1_1_VERSION 0x0302
  255. #define TLS1_2_VERSION 0x0303
  256. #define DTLS1_VERSION 0xfeff
  257. #define DTLS1_2_VERSION 0xfefd
  258. /* SSL_CTX_set_min_version sets the minimum protocol version for |ctx| to
  259. * |version|. */
  260. OPENSSL_EXPORT void SSL_CTX_set_min_version(SSL_CTX *ctx, uint16_t version);
  261. /* SSL_CTX_set_max_version sets the maximum protocol version for |ctx| to
  262. * |version|. */
  263. OPENSSL_EXPORT void SSL_CTX_set_max_version(SSL_CTX *ctx, uint16_t version);
  264. /* SSL_set_min_version sets the minimum protocol version for |ssl| to
  265. * |version|. */
  266. OPENSSL_EXPORT void SSL_set_min_version(SSL *ssl, uint16_t version);
  267. /* SSL_set_max_version sets the maximum protocol version for |ssl| to
  268. * |version|. */
  269. OPENSSL_EXPORT void SSL_set_max_version(SSL *ssl, uint16_t version);
  270. /* Options.
  271. *
  272. * Options configure protocol behavior. */
  273. /* SSL_OP_LEGACY_SERVER_CONNECT allows initial connections to servers that don't
  274. * support the renegotiation_info extension (RFC 5746). It is on by default. */
  275. #define SSL_OP_LEGACY_SERVER_CONNECT 0x00000004L
  276. /* SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER allows for record sizes |SSL3_RT_MAX_EXTRA|
  277. * bytes above the maximum record size. */
  278. #define SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER 0x00000020L
  279. /* SSL_OP_TLS_D5_BUG accepts an RSAClientKeyExchange in TLS encoded as in SSL3
  280. * (i.e. without a length prefix). */
  281. #define SSL_OP_TLS_D5_BUG 0x00000100L
  282. /* SSL_OP_ALL enables the above bug workarounds that are enabled by many
  283. * consumers.
  284. * TODO(davidben): Determine which of the remaining may be removed now. */
  285. #define SSL_OP_ALL 0x00000BFFL
  286. /* SSL_OP_NO_QUERY_MTU, in DTLS, disables querying the MTU from the underlying
  287. * |BIO|. Instead, the MTU is configured with |SSL_set_mtu|. */
  288. #define SSL_OP_NO_QUERY_MTU 0x00001000L
  289. /* SSL_OP_NO_TICKET disables session ticket support (RFC 4507). */
  290. #define SSL_OP_NO_TICKET 0x00004000L
  291. /* SSL_OP_CIPHER_SERVER_PREFERENCE configures servers to select ciphers and
  292. * ECDHE curves according to the server's preferences instead of the
  293. * client's. */
  294. #define SSL_OP_CIPHER_SERVER_PREFERENCE 0x00400000L
  295. /* The following flags toggle individual protocol versions. This is deprecated.
  296. * Use |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version| instead. */
  297. #define SSL_OP_NO_SSLv3 0x02000000L
  298. #define SSL_OP_NO_TLSv1 0x04000000L
  299. #define SSL_OP_NO_TLSv1_2 0x08000000L
  300. #define SSL_OP_NO_TLSv1_1 0x10000000L
  301. #define SSL_OP_NO_DTLSv1 SSL_OP_NO_TLSv1
  302. #define SSL_OP_NO_DTLSv1_2 SSL_OP_NO_TLSv1_2
  303. /* The following flags do nothing and are included only to make it easier to
  304. * compile code with BoringSSL. */
  305. #define SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION 0
  306. #define SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS 0
  307. #define SSL_OP_EPHEMERAL_RSA 0
  308. #define SSL_OP_MICROSOFT_SESS_ID_BUG 0
  309. #define SSL_OP_MSIE_SSLV2_RSA_PADDING 0
  310. #define SSL_OP_NETSCAPE_CA_DN_BUG 0
  311. #define SSL_OP_NETSCAPE_CHALLENGE_BUG 0
  312. #define SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG 0
  313. #define SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG 0
  314. #define SSL_OP_NO_COMPRESSION 0
  315. #define SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION 0
  316. #define SSL_OP_NO_SSLv2 0
  317. #define SSL_OP_PKCS1_CHECK_1 0
  318. #define SSL_OP_PKCS1_CHECK_2 0
  319. #define SSL_OP_SINGLE_DH_USE 0
  320. #define SSL_OP_SINGLE_ECDH_USE 0
  321. #define SSL_OP_SSLEAY_080_CLIENT_DH_BUG 0
  322. #define SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG 0
  323. #define SSL_OP_TLS_BLOCK_PADDING_BUG 0
  324. #define SSL_OP_TLS_ROLLBACK_BUG 0
  325. /* SSL_CTX_set_options enables all options set in |options| (which should be one
  326. * or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
  327. * bitmask representing the resulting enabled options. */
  328. OPENSSL_EXPORT uint32_t SSL_CTX_set_options(SSL_CTX *ctx, uint32_t options);
  329. /* SSL_CTX_clear_options disables all options set in |options| (which should be
  330. * one or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
  331. * bitmask representing the resulting enabled options. */
  332. OPENSSL_EXPORT uint32_t SSL_CTX_clear_options(SSL_CTX *ctx, uint32_t options);
  333. /* SSL_CTX_get_options returns a bitmask of |SSL_OP_*| values that represent all
  334. * the options enabled for |ctx|. */
  335. OPENSSL_EXPORT uint32_t SSL_CTX_get_options(const SSL_CTX *ctx);
  336. /* SSL_set_options enables all options set in |options| (which should be one or
  337. * more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a bitmask
  338. * representing the resulting enabled options. */
  339. OPENSSL_EXPORT uint32_t SSL_set_options(SSL *ssl, uint32_t options);
  340. /* SSL_clear_options disables all options set in |options| (which should be one
  341. * or more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a
  342. * bitmask representing the resulting enabled options. */
  343. OPENSSL_EXPORT uint32_t SSL_clear_options(SSL *ssl, uint32_t options);
  344. /* SSL_get_options returns a bitmask of |SSL_OP_*| values that represent all the
  345. * options enabled for |ssl|. */
  346. OPENSSL_EXPORT uint32_t SSL_get_options(const SSL *ssl);
  347. /* Modes.
  348. *
  349. * Modes configure API behavior. */
  350. /* SSL_MODE_ENABLE_PARTIAL_WRITE allows |SSL_write| to complete with a partial
  351. * result when the only part of the input was written in a single record. */
  352. #define SSL_MODE_ENABLE_PARTIAL_WRITE 0x00000001L
  353. /* SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER allows retrying an incomplete |SSL_write|
  354. * with a different buffer. However, |SSL_write| still assumes the buffer
  355. * contents are unchanged. This is not the default to avoid the misconception
  356. * that non-blocking |SSL_write| behaves like non-blocking |write|. */
  357. #define SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER 0x00000002L
  358. /* SSL_MODE_NO_AUTO_CHAIN disables automatically building a certificate chain
  359. * before sending certificates to the peer.
  360. * TODO(davidben): Remove this behavior. https://crbug.com/486295. */
  361. #define SSL_MODE_NO_AUTO_CHAIN 0x00000008L
  362. /* SSL_MODE_ENABLE_FALSE_START allows clients to send application data before
  363. * receipt of CCS and Finished. This mode enables full-handshakes to 'complete'
  364. * in one RTT. See draft-bmoeller-tls-falsestart-01. */
  365. #define SSL_MODE_ENABLE_FALSE_START 0x00000080L
  366. /* Deprecated: SSL_MODE_HANDSHAKE_CUTTHROUGH is the same as
  367. * SSL_MODE_ENABLE_FALSE_START. */
  368. #define SSL_MODE_HANDSHAKE_CUTTHROUGH SSL_MODE_ENABLE_FALSE_START
  369. /* SSL_MODE_CBC_RECORD_SPLITTING causes multi-byte CBC records in SSL 3.0 and
  370. * TLS 1.0 to be split in two: the first record will contain a single byte and
  371. * the second will contain the remainder. This effectively randomises the IV and
  372. * prevents BEAST attacks. */
  373. #define SSL_MODE_CBC_RECORD_SPLITTING 0x00000100L
  374. /* SSL_MODE_NO_SESSION_CREATION will cause any attempts to create a session to
  375. * fail with SSL_R_SESSION_MAY_NOT_BE_CREATED. This can be used to enforce that
  376. * session resumption is used for a given SSL*. */
  377. #define SSL_MODE_NO_SESSION_CREATION 0x00000200L
  378. /* SSL_MODE_SEND_FALLBACK_SCSV sends TLS_FALLBACK_SCSV in the ClientHello.
  379. * To be set only by applications that reconnect with a downgraded protocol
  380. * version; see RFC 7507 for details.
  381. *
  382. * DO NOT ENABLE THIS if your application attempts a normal handshake. Only use
  383. * this in explicit fallback retries, following the guidance in RFC 7507. */
  384. #define SSL_MODE_SEND_FALLBACK_SCSV 0x00000400L
  385. /* The following flags do nothing and are included only to make it easier to
  386. * compile code with BoringSSL. */
  387. #define SSL_MODE_AUTO_RETRY 0
  388. #define SSL_MODE_RELEASE_BUFFERS 0
  389. #define SSL_MODE_SEND_CLIENTHELLO_TIME 0
  390. #define SSL_MODE_SEND_SERVERHELLO_TIME 0
  391. /* SSL_CTX_set_mode enables all modes set in |mode| (which should be one or more
  392. * of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a bitmask
  393. * representing the resulting enabled modes. */
  394. OPENSSL_EXPORT uint32_t SSL_CTX_set_mode(SSL_CTX *ctx, uint32_t mode);
  395. /* SSL_CTX_clear_mode disables all modes set in |mode| (which should be one or
  396. * more of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a
  397. * bitmask representing the resulting enabled modes. */
  398. OPENSSL_EXPORT uint32_t SSL_CTX_clear_mode(SSL_CTX *ctx, uint32_t mode);
  399. /* SSL_CTX_get_mode returns a bitmask of |SSL_MODE_*| values that represent all
  400. * the modes enabled for |ssl|. */
  401. OPENSSL_EXPORT uint32_t SSL_CTX_get_mode(const SSL_CTX *ctx);
  402. /* SSL_set_mode enables all modes set in |mode| (which should be one or more of
  403. * the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
  404. * representing the resulting enabled modes. */
  405. OPENSSL_EXPORT uint32_t SSL_set_mode(SSL *ssl, uint32_t mode);
  406. /* SSL_clear_mode disables all modes set in |mode| (which should be one or more
  407. * of the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
  408. * representing the resulting enabled modes. */
  409. OPENSSL_EXPORT uint32_t SSL_clear_mode(SSL *ssl, uint32_t mode);
  410. /* SSL_get_mode returns a bitmask of |SSL_MODE_*| values that represent all the
  411. * modes enabled for |ssl|. */
  412. OPENSSL_EXPORT uint32_t SSL_get_mode(const SSL *ssl);
  413. /* Configuring certificates and private keys.
  414. *
  415. * These functions configure the connection's leaf certificate, private key, and
  416. * certificate chain. The certificate chain is ordered leaf to root (as sent on
  417. * the wire) but does not include the leaf. Both client and server certificates
  418. * use these functions.
  419. *
  420. * Certificates and keys may be configured before the handshake or dynamically
  421. * in the early callback and certificate callback. */
  422. /* SSL_CTX_use_certificate sets |ctx|'s leaf certificate to |x509|. It returns
  423. * one on success and zero on failure. */
  424. OPENSSL_EXPORT int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x509);
  425. /* SSL_use_certificate sets |ssl|'s leaf certificate to |x509|. It returns one
  426. * on success and zero on failure. */
  427. OPENSSL_EXPORT int SSL_use_certificate(SSL *ssl, X509 *x509);
  428. /* SSL_CTX_use_PrivateKey sets |ctx|'s private key to |pkey|. It returns one on
  429. * success and zero on failure. */
  430. OPENSSL_EXPORT int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
  431. /* SSL_use_PrivateKey sets |ssl|'s private key to |pkey|. It returns one on
  432. * success and zero on failure. */
  433. OPENSSL_EXPORT int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
  434. /* SSL_CTX_set0_chain sets |ctx|'s certificate chain, excluding the leaf, to
  435. * |chain|. On success, it returns one and takes ownership of |chain|.
  436. * Otherwise, it returns zero. */
  437. OPENSSL_EXPORT int SSL_CTX_set0_chain(SSL_CTX *ctx, STACK_OF(X509) *chain);
  438. /* SSL_CTX_set1_chain sets |ctx|'s certificate chain, excluding the leaf, to
  439. * |chain|. It returns one on success and zero on failure. The caller retains
  440. * ownership of |chain| and may release it freely. */
  441. OPENSSL_EXPORT int SSL_CTX_set1_chain(SSL_CTX *ctx, STACK_OF(X509) *chain);
  442. /* SSL_set0_chain sets |ssl|'s certificate chain, excluding the leaf, to
  443. * |chain|. On success, it returns one and takes ownership of |chain|.
  444. * Otherwise, it returns zero. */
  445. OPENSSL_EXPORT int SSL_set0_chain(SSL *ssl, STACK_OF(X509) *chain);
  446. /* SSL_set1_chain sets |ssl|'s certificate chain, excluding the leaf, to
  447. * |chain|. It returns one on success and zero on failure. The caller retains
  448. * ownership of |chain| and may release it freely. */
  449. OPENSSL_EXPORT int SSL_set1_chain(SSL *ssl, STACK_OF(X509) *chain);
  450. /* SSL_CTX_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On
  451. * success, it returns one and takes ownership of |x509|. Otherwise, it returns
  452. * zero. */
  453. OPENSSL_EXPORT int SSL_CTX_add0_chain_cert(SSL_CTX *ctx, X509 *x509);
  454. /* SSL_CTX_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It
  455. * returns one on success and zero on failure. The caller retains ownership of
  456. * |x509| and may release it freely. */
  457. OPENSSL_EXPORT int SSL_CTX_add1_chain_cert(SSL_CTX *ctx, X509 *x509);
  458. /* SSL_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On success,
  459. * it returns one and takes ownership of |x509|. Otherwise, it returns zero. */
  460. OPENSSL_EXPORT int SSL_add0_chain_cert(SSL *ssl, X509 *x509);
  461. /* SSL_CTX_add_extra_chain_cert calls |SSL_CTX_add0_chain_cert|. */
  462. OPENSSL_EXPORT int SSL_CTX_add_extra_chain_cert(SSL_CTX *ctx, X509 *x509);
  463. /* SSL_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It returns
  464. * one on success and zero on failure. The caller retains ownership of |x509|
  465. * and may release it freely. */
  466. OPENSSL_EXPORT int SSL_add1_chain_cert(SSL *ssl, X509 *x509);
  467. /* SSL_CTX_clear_chain_certs clears |ctx|'s certificate chain and returns
  468. * one. */
  469. OPENSSL_EXPORT int SSL_CTX_clear_chain_certs(SSL_CTX *ctx);
  470. /* SSL_CTX_clear_extra_chain_certs calls |SSL_CTX_clear_chain_certs|. */
  471. OPENSSL_EXPORT int SSL_CTX_clear_extra_chain_certs(SSL_CTX *ctx);
  472. /* SSL_clear_chain_certs clears |ssl|'s certificate chain and returns one. */
  473. OPENSSL_EXPORT int SSL_clear_chain_certs(SSL *ssl);
  474. /* SSL_CTX_set_cert_cb sets a callback that is called to select a certificate.
  475. * The callback returns one on success, zero on internal error, and a negative
  476. * number on failure or to pause the handshake. If the handshake is paused,
  477. * |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|. */
  478. OPENSSL_EXPORT void SSL_CTX_set_cert_cb(SSL_CTX *ctx,
  479. int (*cb)(SSL *ssl, void *arg),
  480. void *arg);
  481. /* SSL_set_cert_cb sets a callback that is called to select a certificate. The
  482. * callback returns one on success, zero on internal error, and a negative
  483. * number on failure or to pause the handshake. If the handshake is paused,
  484. * |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|. */
  485. OPENSSL_EXPORT void SSL_set_cert_cb(SSL *ssl, int (*cb)(SSL *ssl, void *arg),
  486. void *arg);
  487. /* SSL_certs_clear resets the private key, leaf certificate, and certificate
  488. * chain of |ssl|. */
  489. OPENSSL_EXPORT void SSL_certs_clear(SSL *ssl);
  490. /* SSL_CTX_check_private_key returns one if the certificate and private key
  491. * configured in |ctx| are consistent and zero otherwise. */
  492. OPENSSL_EXPORT int SSL_CTX_check_private_key(const SSL_CTX *ctx);
  493. /* SSL_check_private_key returns one if the certificate and private key
  494. * configured in |ssl| are consistent and zero otherwise. */
  495. OPENSSL_EXPORT int SSL_check_private_key(const SSL *ssl);
  496. /* SSL_CTX_get0_certificate returns |ctx|'s leaf certificate. */
  497. OPENSSL_EXPORT X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx);
  498. /* SSL_get_certificate returns |ssl|'s leaf certificate. */
  499. OPENSSL_EXPORT X509 *SSL_get_certificate(const SSL *ssl);
  500. /* SSL_CTX_get0_privatekey returns |ctx|'s private key. */
  501. OPENSSL_EXPORT EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx);
  502. /* SSL_get_privatekey returns |ssl|'s private key. */
  503. OPENSSL_EXPORT EVP_PKEY *SSL_get_privatekey(const SSL *ssl);
  504. /* SSL_CTX_get0_chain_certs sets |*out_chain| to |ctx|'s certificate chain and
  505. * returns one. */
  506. OPENSSL_EXPORT int SSL_CTX_get0_chain_certs(const SSL_CTX *ctx,
  507. STACK_OF(X509) **out_chain);
  508. /* SSL_CTX_get_extra_chain_certs calls |SSL_CTX_get0_chain_certs|. */
  509. OPENSSL_EXPORT int SSL_CTX_get_extra_chain_certs(const SSL_CTX *ctx,
  510. STACK_OF(X509) **out_chain);
  511. /* SSL_get0_chain_certs sets |*out_chain| to |ssl|'s certificate chain and
  512. * returns one. */
  513. OPENSSL_EXPORT int SSL_get0_chain_certs(const SSL *ssl,
  514. STACK_OF(X509) **out_chain);
  515. /* SSL_CTX_set_ocsp_response sets the OCSP reponse that is sent to clients
  516. * which request it. It returns one on success and zero on error. The caller
  517. * retains ownership of |response|. */
  518. OPENSSL_EXPORT int SSL_CTX_set_ocsp_response(SSL_CTX *ctx,
  519. const uint8_t *response,
  520. size_t response_len);
  521. /* Certificate and private key convenience functions. */
  522. /* SSL_CTX_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one
  523. * on success and zero on failure. */
  524. OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
  525. /* SSL_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one on
  526. * success and zero on failure. */
  527. OPENSSL_EXPORT int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
  528. /* The following functions configure certificates or private keys but take as
  529. * input DER-encoded structures. They return one on success and zero on
  530. * failure. */
  531. OPENSSL_EXPORT int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len,
  532. const uint8_t *d);
  533. OPENSSL_EXPORT int SSL_use_certificate_ASN1(SSL *ssl, const uint8_t *der,
  534. int len);
  535. OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx,
  536. const uint8_t *d, long len);
  537. OPENSSL_EXPORT int SSL_use_PrivateKey_ASN1(int type, SSL *ssl,
  538. const uint8_t *d, long len);
  539. OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx,
  540. const uint8_t *der,
  541. size_t der_len);
  542. OPENSSL_EXPORT int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, const uint8_t *der,
  543. size_t der_len);
  544. /* The following functions configure certificates or private keys but take as
  545. * input files to read from. They return one on success and zero on failure. The
  546. * |type| parameter is one of the |SSL_FILETYPE_*| values and determines whether
  547. * the file's contents are read as PEM or DER. */
  548. #define SSL_FILETYPE_ASN1 X509_FILETYPE_ASN1
  549. #define SSL_FILETYPE_PEM X509_FILETYPE_PEM
  550. OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx,
  551. const char *file,
  552. int type);
  553. OPENSSL_EXPORT int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file,
  554. int type);
  555. OPENSSL_EXPORT int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file,
  556. int type);
  557. OPENSSL_EXPORT int SSL_use_certificate_file(SSL *ssl, const char *file,
  558. int type);
  559. OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file,
  560. int type);
  561. OPENSSL_EXPORT int SSL_use_PrivateKey_file(SSL *ssl, const char *file,
  562. int type);
  563. /* SSL_CTX_use_certificate_file configures certificates for |ctx|. It reads the
  564. * contents of |file| as a PEM-encoded leaf certificate followed optionally by
  565. * the certificate chain to send to the peer. It returns one on success and zero
  566. * on failure. */
  567. OPENSSL_EXPORT int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx,
  568. const char *file);
  569. /* Custom private keys. */
  570. enum ssl_private_key_result_t {
  571. ssl_private_key_success,
  572. ssl_private_key_retry,
  573. ssl_private_key_failure,
  574. };
  575. /* SSL_PRIVATE_KEY_METHOD describes private key hooks. This is used to off-load
  576. * signing operations to a custom, potentially asynchronous, backend. */
  577. typedef struct ssl_private_key_method_st {
  578. /* type returns either |EVP_PKEY_RSA| or |EVP_PKEY_EC| to denote the type of
  579. * key used by |ssl|. */
  580. int (*type)(SSL *ssl);
  581. /* supports_digest returns one if the key used by |ssl| supports signing
  582. * digests of type |md| and zero otherwise. */
  583. int (*supports_digest)(SSL *ssl, const EVP_MD *md);
  584. /* max_signature_len returns the maximum length of a signature signed by the
  585. * key used by |ssl|. This must be a constant value for a given |ssl|. */
  586. size_t (*max_signature_len)(SSL *ssl);
  587. /* sign signs |in_len| bytes of digest from |in|. |md| is the hash function
  588. * used to calculate |in|. On success, it returns |ssl_private_key_success|
  589. * and writes at most |max_out| bytes of signature data to |out|. On failure,
  590. * it returns |ssl_private_key_failure|. If the operation has not completed,
  591. * it returns |ssl_private_key_retry|. |sign| should arrange for the
  592. * high-level operation on |ssl| to be retried when the operation is
  593. * completed. This will result in a call to |sign_complete|.
  594. *
  595. * If the key is an RSA key, implementations must use PKCS#1 padding. |in| is
  596. * the digest itself, so the DigestInfo prefix, if any, must be prepended by
  597. * |sign|. If |md| is |EVP_md5_sha1|, there is no prefix.
  598. *
  599. * It is an error to call |sign| while another private key operation is in
  600. * progress on |ssl|. */
  601. enum ssl_private_key_result_t (*sign)(SSL *ssl, uint8_t *out, size_t *out_len,
  602. size_t max_out, const EVP_MD *md,
  603. const uint8_t *in, size_t in_len);
  604. /* sign_complete completes a pending |sign| operation. If the operation has
  605. * completed, it returns |ssl_private_key_success| and writes the result to
  606. * |out| as in |sign|. Otherwise, it returns |ssl_private_key_failure| on
  607. * failure and |ssl_private_key_retry| if the operation is still in progress.
  608. *
  609. * |sign_complete| may be called arbitrarily many times before completion, but
  610. * it is an error to call |sign_complete| if there is no pending |sign|
  611. * operation in progress on |ssl|. */
  612. enum ssl_private_key_result_t (*sign_complete)(SSL *ssl, uint8_t *out,
  613. size_t *out_len, size_t max_out);
  614. } SSL_PRIVATE_KEY_METHOD;
  615. /* SSL_use_private_key_method configures a custom private key on |ssl|.
  616. * |key_method| must remain valid for the lifetime of |ssl|. */
  617. OPENSSL_EXPORT void SSL_set_private_key_method(
  618. SSL *ssl, const SSL_PRIVATE_KEY_METHOD *key_method);
  619. /* Connection information. */
  620. /* SSL_get_tls_unique writes at most |max_out| bytes of the tls-unique value
  621. * for |ssl| to |out| and sets |*out_len| to the number of bytes written. It
  622. * returns one on success or zero on error. In general |max_out| should be at
  623. * least 12.
  624. *
  625. * This function will always fail if the initial handshake has not completed.
  626. * The tls-unique value will change after a renegotiation but, since
  627. * renegotiations can be initiated by the server at any point, the higher-level
  628. * protocol must either leave them disabled or define states in which the
  629. * tls-unique value can be read.
  630. *
  631. * The tls-unique value is defined by
  632. * https://tools.ietf.org/html/rfc5929#section-3.1. Due to a weakness in the
  633. * TLS protocol, tls-unique is broken for resumed connections unless the
  634. * Extended Master Secret extension is negotiated. Thus this function will
  635. * return zero if |ssl| performed session resumption unless EMS was used when
  636. * negotiating the original session. */
  637. OPENSSL_EXPORT int SSL_get_tls_unique(const SSL *ssl, uint8_t *out,
  638. size_t *out_len, size_t max_out);
  639. /* Custom extensions.
  640. *
  641. * The custom extension functions allow TLS extensions to be added to
  642. * ClientHello and ServerHello messages. */
  643. /* SSL_custom_ext_add_cb is a callback function that is called when the
  644. * ClientHello (for clients) or ServerHello (for servers) is constructed. In
  645. * the case of a server, this callback will only be called for a given
  646. * extension if the ClientHello contained that extension – it's not possible to
  647. * inject extensions into a ServerHello that the client didn't request.
  648. *
  649. * When called, |extension_value| will contain the extension number that is
  650. * being considered for addition (so that a single callback can handle multiple
  651. * extensions). If the callback wishes to include the extension, it must set
  652. * |*out| to point to |*out_len| bytes of extension contents and return one. In
  653. * this case, the corresponding |SSL_custom_ext_free_cb| callback will later be
  654. * called with the value of |*out| once that data has been copied.
  655. *
  656. * If the callback does not wish to add an extension it must return zero.
  657. *
  658. * Alternatively, the callback can abort the connection by setting
  659. * |*out_alert_value| to a TLS alert number and returning -1. */
  660. typedef int (*SSL_custom_ext_add_cb)(SSL *ssl, unsigned extension_value,
  661. const uint8_t **out, size_t *out_len,
  662. int *out_alert_value, void *add_arg);
  663. /* SSL_custom_ext_free_cb is a callback function that is called by OpenSSL iff
  664. * an |SSL_custom_ext_add_cb| callback previously returned one. In that case,
  665. * this callback is called and passed the |out| pointer that was returned by
  666. * the add callback. This is to free any dynamically allocated data created by
  667. * the add callback. */
  668. typedef void (*SSL_custom_ext_free_cb)(SSL *ssl, unsigned extension_value,
  669. const uint8_t *out, void *add_arg);
  670. /* SSL_custom_ext_parse_cb is a callback function that is called by OpenSSL to
  671. * parse an extension from the peer: that is from the ServerHello for a client
  672. * and from the ClientHello for a server.
  673. *
  674. * When called, |extension_value| will contain the extension number and the
  675. * contents of the extension are |contents_len| bytes at |contents|.
  676. *
  677. * The callback must return one to continue the handshake. Otherwise, if it
  678. * returns zero, a fatal alert with value |*out_alert_value| is sent and the
  679. * handshake is aborted. */
  680. typedef int (*SSL_custom_ext_parse_cb)(SSL *ssl, unsigned extension_value,
  681. const uint8_t *contents,
  682. size_t contents_len,
  683. int *out_alert_value, void *parse_arg);
  684. /* SSL_extension_supported returns one iff OpenSSL internally handles
  685. * extensions of type |extension_value|. This can be used to avoid registering
  686. * custom extension handlers for extensions that a future version of OpenSSL
  687. * may handle internally. */
  688. OPENSSL_EXPORT int SSL_extension_supported(unsigned extension_value);
  689. /* SSL_CTX_add_client_custom_ext registers callback functions for handling
  690. * custom TLS extensions for client connections.
  691. *
  692. * If |add_cb| is NULL then an empty extension will be added in each
  693. * ClientHello. Otherwise, see the comment for |SSL_custom_ext_add_cb| about
  694. * this callback.
  695. *
  696. * The |free_cb| may be NULL if |add_cb| doesn't dynamically allocate data that
  697. * needs to be freed.
  698. *
  699. * It returns one on success or zero on error. It's always an error to register
  700. * callbacks for the same extension twice, or to register callbacks for an
  701. * extension that OpenSSL handles internally. See |SSL_extension_supported| to
  702. * discover, at runtime, which extensions OpenSSL handles internally. */
  703. OPENSSL_EXPORT int SSL_CTX_add_client_custom_ext(
  704. SSL_CTX *ctx, unsigned extension_value, SSL_custom_ext_add_cb add_cb,
  705. SSL_custom_ext_free_cb free_cb, void *add_arg,
  706. SSL_custom_ext_parse_cb parse_cb, void *parse_arg);
  707. /* SSL_CTX_add_server_custom_ext is the same as
  708. * |SSL_CTX_add_client_custom_ext|, but for server connections.
  709. *
  710. * Unlike on the client side, if |add_cb| is NULL no extension will be added.
  711. * The |add_cb|, if any, will only be called if the ClientHello contained a
  712. * matching extension. */
  713. OPENSSL_EXPORT int SSL_CTX_add_server_custom_ext(
  714. SSL_CTX *ctx, unsigned extension_value, SSL_custom_ext_add_cb add_cb,
  715. SSL_custom_ext_free_cb free_cb, void *add_arg,
  716. SSL_custom_ext_parse_cb parse_cb, void *parse_arg);
  717. /* Session tickets. */
  718. /* SSL_CTX_get_tlsext_ticket_keys writes |ctx|'s session ticket key material to
  719. * |len| bytes of |out|. It returns one on success and zero if |len| is not
  720. * 48. If |out| is NULL, it returns 48 instead. */
  721. OPENSSL_EXPORT int SSL_CTX_get_tlsext_ticket_keys(SSL_CTX *ctx, void *out,
  722. size_t len);
  723. /* SSL_CTX_set_tlsext_ticket_keys sets |ctx|'s session ticket key material to
  724. * |len| bytes of |in|. It returns one on success and zero if |len| is not
  725. * 48. If |in| is NULL, it returns 48 instead. */
  726. OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_keys(SSL_CTX *ctx, const void *in,
  727. size_t len);
  728. /* SSL_TICKET_KEY_NAME_LEN is the length of the key name prefix of a session
  729. * ticket. */
  730. #define SSL_TICKET_KEY_NAME_LEN 16
  731. /* SSL_CTX_set_tlsext_ticket_key_cb sets the ticket callback to |callback| and
  732. * returns one. |callback| will be called when encrypting a new ticket and when
  733. * decrypting a ticket from the client.
  734. *
  735. * In both modes, |ctx| and |hmac_ctx| will already have been initialized with
  736. * |EVP_CIPHER_CTX_init| and |HMAC_CTX_init|, respectively. |callback|
  737. * configures |hmac_ctx| with an HMAC digest and key, and configures |ctx|
  738. * for encryption or decryption, based on the mode.
  739. *
  740. * When encrypting a new ticket, |encrypt| will be one. It writes a public
  741. * 16-byte key name to |key_name| and a fresh IV to |iv|. The output IV length
  742. * must match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
  743. * |callback| returns 1 on success and -1 on error.
  744. *
  745. * When decrypting a ticket, |encrypt| will be zero. |key_name| will point to a
  746. * 16-byte key name and |iv| points to an IV. The length of the IV consumed must
  747. * match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
  748. * |callback| returns -1 to abort the handshake, 0 if decrypting the ticket
  749. * failed, and 1 or 2 on success. If it returns 2, the ticket will be renewed.
  750. * This may be used to re-key the ticket.
  751. *
  752. * WARNING: |callback| wildly breaks the usual return value convention and is
  753. * called in two different modes. */
  754. OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_key_cb(
  755. SSL_CTX *ctx, int (*callback)(SSL *ssl, uint8_t *key_name, uint8_t *iv,
  756. EVP_CIPHER_CTX *ctx, HMAC_CTX *hmac_ctx,
  757. int encrypt));
  758. /* Underdocumented functions.
  759. *
  760. * Functions below here haven't been touched up and may be underdocumented. */
  761. /* SSLeay version number for ASN.1 encoding of the session information */
  762. /* Version 0 - initial version
  763. * Version 1 - added the optional peer certificate. */
  764. #define SSL_SESSION_ASN1_VERSION 0x0001
  765. #define SSL_MAX_SSL_SESSION_ID_LENGTH 32
  766. #define SSL_MAX_SID_CTX_LENGTH 32
  767. #define SSL_MAX_MASTER_KEY_LENGTH 48
  768. /* These are used to specify which ciphers to use and not to use */
  769. #define SSL_TXT_MEDIUM "MEDIUM"
  770. #define SSL_TXT_HIGH "HIGH"
  771. #define SSL_TXT_FIPS "FIPS"
  772. #define SSL_TXT_kRSA "kRSA"
  773. #define SSL_TXT_kDHE "kDHE"
  774. #define SSL_TXT_kEDH "kEDH" /* same as "kDHE" */
  775. #define SSL_TXT_kECDHE "kECDHE"
  776. #define SSL_TXT_kEECDH "kEECDH" /* same as "kECDHE" */
  777. #define SSL_TXT_kPSK "kPSK"
  778. #define SSL_TXT_aRSA "aRSA"
  779. #define SSL_TXT_aECDSA "aECDSA"
  780. #define SSL_TXT_aPSK "aPSK"
  781. #define SSL_TXT_DH "DH"
  782. #define SSL_TXT_DHE "DHE" /* same as "kDHE" */
  783. #define SSL_TXT_EDH "EDH" /* same as "DHE" */
  784. #define SSL_TXT_RSA "RSA"
  785. #define SSL_TXT_ECDH "ECDH"
  786. #define SSL_TXT_ECDHE "ECDHE" /* same as "kECDHE" */
  787. #define SSL_TXT_EECDH "EECDH" /* same as "ECDHE" */
  788. #define SSL_TXT_ECDSA "ECDSA"
  789. #define SSL_TXT_PSK "PSK"
  790. #define SSL_TXT_3DES "3DES"
  791. #define SSL_TXT_RC4 "RC4"
  792. #define SSL_TXT_AES128 "AES128"
  793. #define SSL_TXT_AES256 "AES256"
  794. #define SSL_TXT_AES "AES"
  795. #define SSL_TXT_AES_GCM "AESGCM"
  796. #define SSL_TXT_CHACHA20 "CHACHA20"
  797. #define SSL_TXT_MD5 "MD5"
  798. #define SSL_TXT_SHA1 "SHA1"
  799. #define SSL_TXT_SHA "SHA" /* same as "SHA1" */
  800. #define SSL_TXT_SHA256 "SHA256"
  801. #define SSL_TXT_SHA384 "SHA384"
  802. #define SSL_TXT_SSLV3 "SSLv3"
  803. #define SSL_TXT_TLSV1 "TLSv1"
  804. #define SSL_TXT_TLSV1_1 "TLSv1.1"
  805. #define SSL_TXT_TLSV1_2 "TLSv1.2"
  806. #define SSL_TXT_ALL "ALL"
  807. /* COMPLEMENTOF* definitions. These identifiers are used to (de-select) ciphers
  808. * normally not being used.
  809. *
  810. * Example: "RC4" will activate all ciphers using RC4 including ciphers without
  811. * authentication, which would normally disabled by DEFAULT (due the "!ADH"
  812. * being part of default). Therefore "RC4:!COMPLEMENTOFDEFAULT" will make sure
  813. * that it is also disabled in the specific selection. COMPLEMENTOF*
  814. * identifiers are portable between version, as adjustments to the default
  815. * cipher setup will also be included here.
  816. *
  817. * COMPLEMENTOFDEFAULT does not experience the same special treatment that
  818. * DEFAULT gets, as only selection is being done and no sorting as needed for
  819. * DEFAULT. */
  820. #define SSL_TXT_CMPDEF "COMPLEMENTOFDEFAULT"
  821. /* The following cipher list is used by default. It also is substituted when an
  822. * application-defined cipher list string starts with 'DEFAULT'. */
  823. #define SSL_DEFAULT_CIPHER_LIST "ALL"
  824. /* As of OpenSSL 1.0.0, ssl_create_cipher_list() in ssl/ssl_ciph.c always
  825. * starts with a reasonable order, and all we have to do for DEFAULT is
  826. * throwing out anonymous and unencrypted ciphersuites! (The latter are not
  827. * actually enabled by ALL, but "ALL:RSA" would enable some of them.) */
  828. /* Used in SSL_set_shutdown()/SSL_get_shutdown(); */
  829. #define SSL_SENT_SHUTDOWN 1
  830. #define SSL_RECEIVED_SHUTDOWN 2
  831. typedef struct ssl_protocol_method_st SSL_PROTOCOL_METHOD;
  832. typedef struct ssl_session_st SSL_SESSION;
  833. typedef struct ssl_conf_ctx_st SSL_CONF_CTX;
  834. typedef struct ssl3_enc_method SSL3_ENC_METHOD;
  835. /* SRTP protection profiles for use with the use_srtp extension (RFC 5764). */
  836. typedef struct srtp_protection_profile_st {
  837. const char *name;
  838. unsigned long id;
  839. } SRTP_PROTECTION_PROFILE;
  840. DECLARE_STACK_OF(SRTP_PROTECTION_PROFILE)
  841. /* An SSL_SESSION represents an SSL session that may be resumed in an
  842. * abbreviated handshake. */
  843. struct ssl_session_st {
  844. int ssl_version; /* what ssl version session info is being kept in here? */
  845. int master_key_length;
  846. uint8_t master_key[SSL_MAX_MASTER_KEY_LENGTH];
  847. /* session_id - valid? */
  848. unsigned int session_id_length;
  849. uint8_t session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
  850. /* this is used to determine whether the session is being reused in
  851. * the appropriate context. It is up to the application to set this,
  852. * via SSL_new */
  853. unsigned int sid_ctx_length;
  854. uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
  855. char *psk_identity;
  856. /* Used to indicate that session resumption is not allowed. Applications can
  857. * also set this bit for a new session via not_resumable_session_cb to
  858. * disable session caching and tickets. */
  859. int not_resumable;
  860. /* peer is the peer's certificate. */
  861. X509 *peer;
  862. /* cert_chain is the certificate chain sent by the peer. NOTE: for historical
  863. * reasons, when a client (so the peer is a server), the chain includes
  864. * |peer|, but when a server it does not. */
  865. STACK_OF(X509) *cert_chain;
  866. /* when app_verify_callback accepts a session where the peer's certificate is
  867. * not ok, we must remember the error for session reuse: */
  868. long verify_result; /* only for servers */
  869. CRYPTO_refcount_t references;
  870. long timeout;
  871. long time;
  872. const SSL_CIPHER *cipher;
  873. /* key_exchange_info contains an indication of the size of the asymmetric
  874. * primitive used in the handshake that created this session. In the event
  875. * that two asymmetric operations are used, this value applies to the one
  876. * that controls the confidentiality of the connection. Its interpretation
  877. * depends on the primitive that was used; as specified by the cipher suite:
  878. * DHE: the size, in bits, of the multiplicative group.
  879. * RSA: the size, in bits, of the modulus.
  880. * ECDHE: the TLS id for the curve.
  881. *
  882. * A zero indicates that the value is unknown. */
  883. uint32_t key_exchange_info;
  884. CRYPTO_EX_DATA ex_data; /* application specific data */
  885. /* These are used to make removal of session-ids more efficient and to
  886. * implement a maximum cache size. */
  887. SSL_SESSION *prev, *next;
  888. char *tlsext_hostname;
  889. /* RFC4507 info */
  890. uint8_t *tlsext_tick; /* Session ticket */
  891. size_t tlsext_ticklen; /* Session ticket length */
  892. uint32_t tlsext_tick_lifetime_hint; /* Session lifetime hint in seconds */
  893. size_t tlsext_signed_cert_timestamp_list_length;
  894. uint8_t *tlsext_signed_cert_timestamp_list; /* Server's list. */
  895. /* The OCSP response that came with the session. */
  896. size_t ocsp_response_length;
  897. uint8_t *ocsp_response;
  898. char peer_sha256_valid; /* Non-zero if peer_sha256 is valid */
  899. uint8_t
  900. peer_sha256[SHA256_DIGEST_LENGTH]; /* SHA256 of peer certificate */
  901. /* original_handshake_hash contains the handshake hash (either SHA-1+MD5 or
  902. * SHA-2, depending on TLS version) for the original, full handshake that
  903. * created a session. This is used by Channel IDs during resumption. */
  904. uint8_t original_handshake_hash[EVP_MAX_MD_SIZE];
  905. unsigned int original_handshake_hash_len;
  906. /* extended_master_secret is true if the master secret in this session was
  907. * generated using EMS and thus isn't vulnerable to the Triple Handshake
  908. * attack. */
  909. char extended_master_secret;
  910. };
  911. /* SSL_set_mtu sets the |ssl|'s MTU in DTLS to |mtu|. It returns one on success
  912. * and zero on failure. */
  913. OPENSSL_EXPORT int SSL_set_mtu(SSL *ssl, unsigned mtu);
  914. /* SSL_get_secure_renegotiation_support returns one if the peer supports secure
  915. * renegotiation (RFC 5746) and zero otherwise. */
  916. OPENSSL_EXPORT int SSL_get_secure_renegotiation_support(const SSL *ssl);
  917. /* SSL_CTX_set_msg_callback installs |cb| as the message callback for |ctx|.
  918. * This callback will be called when sending or receiving low-level record
  919. * headers, complete handshake messages, ChangeCipherSpec, and alerts.
  920. * |write_p| is one for outgoing messages and zero for incoming messages.
  921. *
  922. * For each record header, |cb| is called with |version| = 0 and |content_type|
  923. * = |SSL3_RT_HEADER|. The |len| bytes from |buf| contain the header. Note that
  924. * this does not include the record body. If the record is sealed, the length
  925. * in the header is the length of the ciphertext.
  926. *
  927. * For each handshake message, ChangeCipherSpec, and alert, |version| is the
  928. * protocol version and |content_type| is the corresponding record type. The
  929. * |len| bytes from |buf| contain the handshake message, one-byte
  930. * ChangeCipherSpec body, and two-byte alert, respectively. */
  931. OPENSSL_EXPORT void SSL_CTX_set_msg_callback(
  932. SSL_CTX *ctx, void (*cb)(int write_p, int version, int content_type,
  933. const void *buf, size_t len, SSL *ssl, void *arg));
  934. /* SSL_CTX_set_msg_callback_arg sets the |arg| parameter of the message
  935. * callback. */
  936. OPENSSL_EXPORT void SSL_CTX_set_msg_callback_arg(SSL_CTX *ctx, void *arg);
  937. /* SSL_set_msg_callback installs |cb| as the message callback of |ssl|. See
  938. * |SSL_CTX_set_msg_callback| for when this callback is called. */
  939. OPENSSL_EXPORT void SSL_set_msg_callback(
  940. SSL *ssl, void (*cb)(int write_p, int version, int content_type,
  941. const void *buf, size_t len, SSL *ssl, void *arg));
  942. /* SSL_set_msg_callback_arg sets the |arg| parameter of the message callback. */
  943. OPENSSL_EXPORT void SSL_set_msg_callback_arg(SSL *ssl, void *arg);
  944. /* SSL_CTX_set_keylog_bio sets configures all SSL objects attached to |ctx| to
  945. * log session material to |keylog_bio|. This is intended for debugging use
  946. * with tools like Wireshark. |ctx| takes ownership of |keylog_bio|.
  947. *
  948. * The format is described in
  949. * https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format. */
  950. OPENSSL_EXPORT void SSL_CTX_set_keylog_bio(SSL_CTX *ctx, BIO *keylog_bio);
  951. struct ssl_aead_ctx_st;
  952. typedef struct ssl_aead_ctx_st SSL_AEAD_CTX;
  953. #define SSL_MAX_CERT_LIST_DEFAULT 1024 * 100 /* 100k max cert list */
  954. #define SSL_SESSION_CACHE_MAX_SIZE_DEFAULT (1024 * 20)
  955. #define SSL_DEFAULT_SESSION_TIMEOUT (2 * 60 * 60)
  956. /* This callback type is used inside SSL_CTX, SSL, and in the functions that
  957. * set them. It is used to override the generation of SSL/TLS session IDs in a
  958. * server. Return value should be zero on an error, non-zero to proceed. Also,
  959. * callbacks should themselves check if the id they generate is unique
  960. * otherwise the SSL handshake will fail with an error - callbacks can do this
  961. * using the 'ssl' value they're passed by;
  962. * SSL_has_matching_session_id(ssl, id, *id_len)
  963. * The length value passed in is set at the maximum size the session ID can be.
  964. * In SSLv2 this is 16 bytes, whereas SSLv3/TLSv1 it is 32 bytes. The callback
  965. * can alter this length to be less if desired, but under SSLv2 session IDs are
  966. * supposed to be fixed at 16 bytes so the id will be padded after the callback
  967. * returns in this case. It is also an error for the callback to set the size
  968. * to zero. */
  969. typedef int (*GEN_SESSION_CB)(const SSL *ssl, uint8_t *id,
  970. unsigned int *id_len);
  971. /* ssl_early_callback_ctx is passed to certain callbacks that are called very
  972. * early on during the server handshake. At this point, much of the SSL* hasn't
  973. * been filled out and only the ClientHello can be depended on. */
  974. struct ssl_early_callback_ctx {
  975. SSL *ssl;
  976. const uint8_t *client_hello;
  977. size_t client_hello_len;
  978. const uint8_t *session_id;
  979. size_t session_id_len;
  980. const uint8_t *cipher_suites;
  981. size_t cipher_suites_len;
  982. const uint8_t *compression_methods;
  983. size_t compression_methods_len;
  984. const uint8_t *extensions;
  985. size_t extensions_len;
  986. };
  987. /* SSL_early_callback_ctx_extension_get searches the extensions in |ctx| for an
  988. * extension of the given type. If not found, it returns zero. Otherwise it
  989. * sets |out_data| to point to the extension contents (not including the type
  990. * and length bytes), sets |out_len| to the length of the extension contents
  991. * and returns one. */
  992. OPENSSL_EXPORT char SSL_early_callback_ctx_extension_get(
  993. const struct ssl_early_callback_ctx *ctx, uint16_t extension_type,
  994. const uint8_t **out_data, size_t *out_len);
  995. typedef struct ssl_comp_st SSL_COMP;
  996. struct ssl_comp_st {
  997. int id;
  998. const char *name;
  999. char *method;
  1000. };
  1001. DECLARE_STACK_OF(SSL_COMP)
  1002. DECLARE_LHASH_OF(SSL_SESSION)
  1003. /* ssl_cipher_preference_list_st contains a list of SSL_CIPHERs with
  1004. * equal-preference groups. For TLS clients, the groups are moot because the
  1005. * server picks the cipher and groups cannot be expressed on the wire. However,
  1006. * for servers, the equal-preference groups allow the client's preferences to
  1007. * be partially respected. (This only has an effect with
  1008. * SSL_OP_CIPHER_SERVER_PREFERENCE).
  1009. *
  1010. * The equal-preference groups are expressed by grouping SSL_CIPHERs together.
  1011. * All elements of a group have the same priority: no ordering is expressed
  1012. * within a group.
  1013. *
  1014. * The values in |ciphers| are in one-to-one correspondence with
  1015. * |in_group_flags|. (That is, sk_SSL_CIPHER_num(ciphers) is the number of
  1016. * bytes in |in_group_flags|.) The bytes in |in_group_flags| are either 1, to
  1017. * indicate that the corresponding SSL_CIPHER is not the last element of a
  1018. * group, or 0 to indicate that it is.
  1019. *
  1020. * For example, if |in_group_flags| contains all zeros then that indicates a
  1021. * traditional, fully-ordered preference. Every SSL_CIPHER is the last element
  1022. * of the group (i.e. they are all in a one-element group).
  1023. *
  1024. * For a more complex example, consider:
  1025. * ciphers: A B C D E F
  1026. * in_group_flags: 1 1 0 0 1 0
  1027. *
  1028. * That would express the following, order:
  1029. *
  1030. * A E
  1031. * B -> D -> F
  1032. * C
  1033. */
  1034. struct ssl_cipher_preference_list_st {
  1035. STACK_OF(SSL_CIPHER) *ciphers;
  1036. uint8_t *in_group_flags;
  1037. };
  1038. struct ssl_ctx_st {
  1039. const SSL_PROTOCOL_METHOD *method;
  1040. /* lock is used to protect various operations on this object. */
  1041. CRYPTO_MUTEX lock;
  1042. /* max_version is the maximum acceptable protocol version. If zero, the
  1043. * maximum supported version, currently (D)TLS 1.2, is used. */
  1044. uint16_t max_version;
  1045. /* min_version is the minimum acceptable protocl version. If zero, the
  1046. * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
  1047. uint16_t min_version;
  1048. struct ssl_cipher_preference_list_st *cipher_list;
  1049. /* same as above but sorted for lookup */
  1050. STACK_OF(SSL_CIPHER) *cipher_list_by_id;
  1051. /* cipher_list_tls11 is the list of ciphers when TLS 1.1 or greater is in
  1052. * use. This only applies to server connections as, for clients, the version
  1053. * number is known at connect time and so the cipher list can be set then. */
  1054. struct ssl_cipher_preference_list_st *cipher_list_tls11;
  1055. X509_STORE *cert_store;
  1056. LHASH_OF(SSL_SESSION) *sessions;
  1057. /* Most session-ids that will be cached, default is
  1058. * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited. */
  1059. unsigned long session_cache_size;
  1060. SSL_SESSION *session_cache_head;
  1061. SSL_SESSION *session_cache_tail;
  1062. /* handshakes_since_cache_flush is the number of successful handshakes since
  1063. * the last cache flush. */
  1064. int handshakes_since_cache_flush;
  1065. /* This can have one of 2 values, ored together,
  1066. * SSL_SESS_CACHE_CLIENT,
  1067. * SSL_SESS_CACHE_SERVER,
  1068. * Default is SSL_SESSION_CACHE_SERVER, which means only
  1069. * SSL_accept which cache SSL_SESSIONS. */
  1070. int session_cache_mode;
  1071. /* If timeout is not 0, it is the default timeout value set when SSL_new() is
  1072. * called. This has been put in to make life easier to set things up */
  1073. long session_timeout;
  1074. /* If this callback is not null, it will be called each time a session id is
  1075. * added to the cache. If this function returns 1, it means that the
  1076. * callback will do a SSL_SESSION_free() when it has finished using it.
  1077. * Otherwise, on 0, it means the callback has finished with it. If
  1078. * remove_session_cb is not null, it will be called when a session-id is
  1079. * removed from the cache. After the call, OpenSSL will SSL_SESSION_free()
  1080. * it. */
  1081. int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess);
  1082. void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess);
  1083. SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
  1084. int *copy);
  1085. CRYPTO_refcount_t references;
  1086. /* if defined, these override the X509_verify_cert() calls */
  1087. int (*app_verify_callback)(X509_STORE_CTX *, void *);
  1088. void *app_verify_arg;
  1089. /* before OpenSSL 0.9.7, 'app_verify_arg' was ignored ('app_verify_callback'
  1090. * was called with just one argument) */
  1091. /* Default password callback. */
  1092. pem_password_cb *default_passwd_callback;
  1093. /* Default password callback user data. */
  1094. void *default_passwd_callback_userdata;
  1095. /* get client cert callback */
  1096. int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey);
  1097. /* get channel id callback */
  1098. void (*channel_id_cb)(SSL *ssl, EVP_PKEY **pkey);
  1099. CRYPTO_EX_DATA ex_data;
  1100. /* custom_*_extensions stores any callback sets for custom extensions. Note
  1101. * that these pointers will be NULL if the stack would otherwise be empty. */
  1102. STACK_OF(SSL_CUSTOM_EXTENSION) *client_custom_extensions;
  1103. STACK_OF(SSL_CUSTOM_EXTENSION) *server_custom_extensions;
  1104. /* Default values used when no per-SSL value is defined follow */
  1105. void (*info_callback)(const SSL *ssl, int type,
  1106. int val); /* used if SSL's info_callback is NULL */
  1107. /* what we put in client cert requests */
  1108. STACK_OF(X509_NAME) *client_CA;
  1109. /* Default values to use in SSL structures follow (these are copied by
  1110. * SSL_new) */
  1111. uint32_t options;
  1112. uint32_t mode;
  1113. uint32_t max_cert_list;
  1114. struct cert_st /* CERT */ *cert;
  1115. /* callback that allows applications to peek at protocol messages */
  1116. void (*msg_callback)(int write_p, int version, int content_type,
  1117. const void *buf, size_t len, SSL *ssl, void *arg);
  1118. void *msg_callback_arg;
  1119. int verify_mode;
  1120. unsigned int sid_ctx_length;
  1121. uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
  1122. int (*default_verify_callback)(
  1123. int ok, X509_STORE_CTX *ctx); /* called 'verify_callback' in the SSL */
  1124. /* Default generate session ID callback. */
  1125. GEN_SESSION_CB generate_session_id;
  1126. X509_VERIFY_PARAM *param;
  1127. /* select_certificate_cb is called before most ClientHello processing and
  1128. * before the decision whether to resume a session is made. It may return one
  1129. * to continue the handshake or zero to cause the handshake loop to return
  1130. * with an error and cause SSL_get_error to return
  1131. * SSL_ERROR_PENDING_CERTIFICATE. Note: when the handshake loop is resumed, it
  1132. * will not call the callback a second time. */
  1133. int (*select_certificate_cb)(const struct ssl_early_callback_ctx *);
  1134. /* dos_protection_cb is called once the resumption decision for a ClientHello
  1135. * has been made. It returns one to continue the handshake or zero to
  1136. * abort. */
  1137. int (*dos_protection_cb) (const struct ssl_early_callback_ctx *);
  1138. /* quiet_shutdown is true if the connection should not send a close_notify on
  1139. * shutdown. */
  1140. int quiet_shutdown;
  1141. /* Maximum amount of data to send in one fragment. actual record size can be
  1142. * more than this due to padding and MAC overheads. */
  1143. uint16_t max_send_fragment;
  1144. /* TLS extensions servername callback */
  1145. int (*tlsext_servername_callback)(SSL *, int *, void *);
  1146. void *tlsext_servername_arg;
  1147. /* RFC 4507 session ticket keys */
  1148. uint8_t tlsext_tick_key_name[SSL_TICKET_KEY_NAME_LEN];
  1149. uint8_t tlsext_tick_hmac_key[16];
  1150. uint8_t tlsext_tick_aes_key[16];
  1151. /* Callback to support customisation of ticket key setting */
  1152. int (*tlsext_ticket_key_cb)(SSL *ssl, uint8_t *name, uint8_t *iv,
  1153. EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
  1154. /* Server-only: psk_identity_hint is the default identity hint to send in
  1155. * PSK-based key exchanges. */
  1156. char *psk_identity_hint;
  1157. unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
  1158. char *identity,
  1159. unsigned int max_identity_len,
  1160. uint8_t *psk, unsigned int max_psk_len);
  1161. unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
  1162. uint8_t *psk, unsigned int max_psk_len);
  1163. /* retain_only_sha256_of_client_certs is true if we should compute the SHA256
  1164. * hash of the peer's certifiate and then discard it to save memory and
  1165. * session space. Only effective on the server side. */
  1166. char retain_only_sha256_of_client_certs;
  1167. /* Next protocol negotiation information */
  1168. /* (for experimental NPN extension). */
  1169. /* For a server, this contains a callback function by which the set of
  1170. * advertised protocols can be provided. */
  1171. int (*next_protos_advertised_cb)(SSL *s, const uint8_t **buf,
  1172. unsigned int *len, void *arg);
  1173. void *next_protos_advertised_cb_arg;
  1174. /* For a client, this contains a callback function that selects the
  1175. * next protocol from the list provided by the server. */
  1176. int (*next_proto_select_cb)(SSL *s, uint8_t **out, uint8_t *outlen,
  1177. const uint8_t *in, unsigned int inlen, void *arg);
  1178. void *next_proto_select_cb_arg;
  1179. /* ALPN information
  1180. * (we are in the process of transitioning from NPN to ALPN.) */
  1181. /* For a server, this contains a callback function that allows the
  1182. * server to select the protocol for the connection.
  1183. * out: on successful return, this must point to the raw protocol
  1184. * name (without the length prefix).
  1185. * outlen: on successful return, this contains the length of |*out|.
  1186. * in: points to the client's list of supported protocols in
  1187. * wire-format.
  1188. * inlen: the length of |in|. */
  1189. int (*alpn_select_cb)(SSL *s, const uint8_t **out, uint8_t *outlen,
  1190. const uint8_t *in, unsigned int inlen, void *arg);
  1191. void *alpn_select_cb_arg;
  1192. /* For a client, this contains the list of supported protocols in wire
  1193. * format. */
  1194. uint8_t *alpn_client_proto_list;
  1195. unsigned alpn_client_proto_list_len;
  1196. /* SRTP profiles we are willing to do from RFC 5764 */
  1197. STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
  1198. /* EC extension values inherited by SSL structure */
  1199. size_t tlsext_ellipticcurvelist_length;
  1200. uint16_t *tlsext_ellipticcurvelist;
  1201. /* If true, a client will advertise the Channel ID extension and a server
  1202. * will echo it. */
  1203. char tlsext_channel_id_enabled;
  1204. /* The client's Channel ID private key. */
  1205. EVP_PKEY *tlsext_channel_id_private;
  1206. /* If true, a client will request certificate timestamps. */
  1207. char signed_cert_timestamps_enabled;
  1208. /* If true, a client will request a stapled OCSP response. */
  1209. char ocsp_stapling_enabled;
  1210. /* OCSP response to be sent to the client, if requested. */
  1211. uint8_t *ocsp_response;
  1212. size_t ocsp_response_length;
  1213. /* If not NULL, session key material will be logged to this BIO for debugging
  1214. * purposes. The format matches NSS's and is readable by Wireshark. */
  1215. BIO *keylog_bio;
  1216. /* current_time_cb, if not NULL, is the function to use to get the current
  1217. * time. It sets |*out_clock| to the current time. */
  1218. void (*current_time_cb)(const SSL *ssl, struct timeval *out_clock);
  1219. };
  1220. OPENSSL_EXPORT LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx);
  1221. /* SSL_CTX_sess_number returns the number of sessions in |ctx|'s internal
  1222. * session cache. */
  1223. OPENSSL_EXPORT size_t SSL_CTX_sess_number(const SSL_CTX *ctx);
  1224. OPENSSL_EXPORT void SSL_CTX_sess_set_new_cb(
  1225. SSL_CTX *ctx, int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess));
  1226. OPENSSL_EXPORT int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(SSL *ssl,
  1227. SSL_SESSION *sess);
  1228. OPENSSL_EXPORT void SSL_CTX_sess_set_remove_cb(
  1229. SSL_CTX *ctx,
  1230. void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess));
  1231. OPENSSL_EXPORT void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(
  1232. SSL_CTX *ctx, SSL_SESSION *sess);
  1233. OPENSSL_EXPORT void SSL_CTX_sess_set_get_cb(
  1234. SSL_CTX *ctx,
  1235. SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
  1236. int *copy));
  1237. OPENSSL_EXPORT SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(
  1238. SSL *ssl, uint8_t *data, int len, int *copy);
  1239. /* SSL_magic_pending_session_ptr returns a magic SSL_SESSION* which indicates
  1240. * that the session isn't currently unavailable. SSL_get_error will then return
  1241. * SSL_ERROR_PENDING_SESSION and the handshake can be retried later when the
  1242. * lookup has completed. */
  1243. OPENSSL_EXPORT SSL_SESSION *SSL_magic_pending_session_ptr(void);
  1244. OPENSSL_EXPORT void SSL_CTX_set_info_callback(SSL_CTX *ctx,
  1245. void (*cb)(const SSL *ssl,
  1246. int type, int val));
  1247. OPENSSL_EXPORT void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl,
  1248. int type,
  1249. int val);
  1250. OPENSSL_EXPORT void SSL_CTX_set_client_cert_cb(
  1251. SSL_CTX *ctx,
  1252. int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));
  1253. OPENSSL_EXPORT int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL *ssl,
  1254. X509 **x509,
  1255. EVP_PKEY **pkey);
  1256. OPENSSL_EXPORT void SSL_CTX_set_channel_id_cb(
  1257. SSL_CTX *ctx, void (*channel_id_cb)(SSL *ssl, EVP_PKEY **pkey));
  1258. OPENSSL_EXPORT void (*SSL_CTX_get_channel_id_cb(SSL_CTX *ctx))(SSL *ssl,
  1259. EVP_PKEY **pkey);
  1260. /* SSL_enable_signed_cert_timestamps causes |ssl| (which must be the client end
  1261. * of a connection) to request SCTs from the server. See
  1262. * https://tools.ietf.org/html/rfc6962. It returns one. */
  1263. OPENSSL_EXPORT int SSL_enable_signed_cert_timestamps(SSL *ssl);
  1264. /* SSL_CTX_enable_signed_cert_timestamps enables SCT requests on all client SSL
  1265. * objects created from |ctx|. */
  1266. OPENSSL_EXPORT void SSL_CTX_enable_signed_cert_timestamps(SSL_CTX *ctx);
  1267. /* SSL_enable_ocsp_stapling causes |ssl| (which must be the client end of a
  1268. * connection) to request a stapled OCSP response from the server. It returns
  1269. * one. */
  1270. OPENSSL_EXPORT int SSL_enable_ocsp_stapling(SSL *ssl);
  1271. /* SSL_CTX_enable_ocsp_stapling enables OCSP stapling on all client SSL objects
  1272. * created from |ctx|. */
  1273. OPENSSL_EXPORT void SSL_CTX_enable_ocsp_stapling(SSL_CTX *ctx);
  1274. /* SSL_get0_signed_cert_timestamp_list sets |*out| and |*out_len| to point to
  1275. * |*out_len| bytes of SCT information from the server. This is only valid if
  1276. * |ssl| is a client. The SCT information is a SignedCertificateTimestampList
  1277. * (including the two leading length bytes).
  1278. * See https://tools.ietf.org/html/rfc6962#section-3.3
  1279. * If no SCT was received then |*out_len| will be zero on return.
  1280. *
  1281. * WARNING: the returned data is not guaranteed to be well formed. */
  1282. OPENSSL_EXPORT void SSL_get0_signed_cert_timestamp_list(const SSL *ssl,
  1283. const uint8_t **out,
  1284. size_t *out_len);
  1285. /* SSL_get0_ocsp_response sets |*out| and |*out_len| to point to |*out_len|
  1286. * bytes of an OCSP response from the server. This is the DER encoding of an
  1287. * OCSPResponse type as defined in RFC 2560.
  1288. *
  1289. * WARNING: the returned data is not guaranteed to be well formed. */
  1290. OPENSSL_EXPORT void SSL_get0_ocsp_response(const SSL *ssl, const uint8_t **out,
  1291. size_t *out_len);
  1292. OPENSSL_EXPORT void SSL_CTX_set_next_protos_advertised_cb(
  1293. SSL_CTX *s,
  1294. int (*cb)(SSL *ssl, const uint8_t **out, unsigned int *outlen, void *arg),
  1295. void *arg);
  1296. OPENSSL_EXPORT void SSL_CTX_set_next_proto_select_cb(
  1297. SSL_CTX *s, int (*cb)(SSL *ssl, uint8_t **out, uint8_t *outlen,
  1298. const uint8_t *in, unsigned int inlen, void *arg),
  1299. void *arg);
  1300. OPENSSL_EXPORT void SSL_get0_next_proto_negotiated(const SSL *s,
  1301. const uint8_t **data,
  1302. unsigned *len);
  1303. OPENSSL_EXPORT int SSL_select_next_proto(uint8_t **out, uint8_t *outlen,
  1304. const uint8_t *in, unsigned int inlen,
  1305. const uint8_t *client,
  1306. unsigned int client_len);
  1307. #define OPENSSL_NPN_UNSUPPORTED 0
  1308. #define OPENSSL_NPN_NEGOTIATED 1
  1309. #define OPENSSL_NPN_NO_OVERLAP 2
  1310. /* SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
  1311. * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
  1312. * length-prefixed strings). It returns zero on success and one on failure.
  1313. *
  1314. * WARNING: this function is dangerous because it breaks the usual return value
  1315. * convention. */
  1316. OPENSSL_EXPORT int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const uint8_t *protos,
  1317. unsigned protos_len);
  1318. /* SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
  1319. * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
  1320. * length-prefixed strings). It returns zero on success and one on failure.
  1321. *
  1322. * WARNING: this function is dangerous because it breaks the usual return value
  1323. * convention. */
  1324. OPENSSL_EXPORT int SSL_set_alpn_protos(SSL *ssl, const uint8_t *protos,
  1325. unsigned protos_len);
  1326. OPENSSL_EXPORT void SSL_CTX_set_alpn_select_cb(
  1327. SSL_CTX *ctx, int (*cb)(SSL *ssl, const uint8_t **out, uint8_t *outlen,
  1328. const uint8_t *in, unsigned int inlen, void *arg),
  1329. void *arg);
  1330. OPENSSL_EXPORT void SSL_get0_alpn_selected(const SSL *ssl, const uint8_t **data,
  1331. unsigned *len);
  1332. /* SSL_set_reject_peer_renegotiations controls whether renegotiation attempts by
  1333. * the peer are rejected. It may be set at any point in a connection's lifetime
  1334. * to control future renegotiations programmatically. By default, renegotiations
  1335. * are rejected. (Renegotiations requested by a client are always rejected.) */
  1336. OPENSSL_EXPORT void SSL_set_reject_peer_renegotiations(SSL *ssl, int reject);
  1337. /* the maximum length of the buffer given to callbacks containing the resulting
  1338. * identity/psk */
  1339. #define PSK_MAX_IDENTITY_LEN 128
  1340. #define PSK_MAX_PSK_LEN 256
  1341. OPENSSL_EXPORT void SSL_CTX_set_psk_client_callback(
  1342. SSL_CTX *ctx,
  1343. unsigned int (*psk_client_callback)(
  1344. SSL *ssl, const char *hint, char *identity,
  1345. unsigned int max_identity_len, uint8_t *psk, unsigned int max_psk_len));
  1346. OPENSSL_EXPORT void SSL_set_psk_client_callback(
  1347. SSL *ssl, unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
  1348. char *identity,
  1349. unsigned int max_identity_len,
  1350. uint8_t *psk,
  1351. unsigned int max_psk_len));
  1352. OPENSSL_EXPORT void SSL_CTX_set_psk_server_callback(
  1353. SSL_CTX *ctx,
  1354. unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
  1355. uint8_t *psk,
  1356. unsigned int max_psk_len));
  1357. OPENSSL_EXPORT void SSL_set_psk_server_callback(
  1358. SSL *ssl,
  1359. unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
  1360. uint8_t *psk,
  1361. unsigned int max_psk_len));
  1362. OPENSSL_EXPORT int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx,
  1363. const char *identity_hint);
  1364. OPENSSL_EXPORT int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint);
  1365. OPENSSL_EXPORT const char *SSL_get_psk_identity_hint(const SSL *s);
  1366. OPENSSL_EXPORT const char *SSL_get_psk_identity(const SSL *s);
  1367. #define SSL_NOTHING 1
  1368. #define SSL_WRITING 2
  1369. #define SSL_READING 3
  1370. #define SSL_X509_LOOKUP 4
  1371. #define SSL_CHANNEL_ID_LOOKUP 5
  1372. #define SSL_PENDING_SESSION 7
  1373. #define SSL_CERTIFICATE_SELECTION_PENDING 8
  1374. #define SSL_PRIVATE_KEY_OPERATION 9
  1375. /* These will only be used when doing non-blocking IO */
  1376. #define SSL_want_nothing(s) (SSL_want(s) == SSL_NOTHING)
  1377. #define SSL_want_read(s) (SSL_want(s) == SSL_READING)
  1378. #define SSL_want_write(s) (SSL_want(s) == SSL_WRITING)
  1379. #define SSL_want_x509_lookup(s) (SSL_want(s) == SSL_X509_LOOKUP)
  1380. #define SSL_want_channel_id_lookup(s) (SSL_want(s) == SSL_CHANNEL_ID_LOOKUP)
  1381. #define SSL_want_session(s) (SSL_want(s) == SSL_PENDING_SESSION)
  1382. #define SSL_want_certificate(s) \
  1383. (SSL_want(s) == SSL_CERTIFICATE_SELECTION_PENDING)
  1384. #define SSL_want_private_key_operation(s) \
  1385. (SSL_want(s) == SSL_PRIVATE_KEY_OPERATION)
  1386. struct ssl_st {
  1387. /* version is the protocol version. */
  1388. int version;
  1389. /* method is the method table corresponding to the current protocol (DTLS or
  1390. * TLS). */
  1391. const SSL_PROTOCOL_METHOD *method;
  1392. /* enc_method is the method table corresponding to the current protocol
  1393. * version. */
  1394. const SSL3_ENC_METHOD *enc_method;
  1395. /* max_version is the maximum acceptable protocol version. If zero, the
  1396. * maximum supported version, currently (D)TLS 1.2, is used. */
  1397. uint16_t max_version;
  1398. /* min_version is the minimum acceptable protocl version. If zero, the
  1399. * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
  1400. uint16_t min_version;
  1401. /* There are 2 BIO's even though they are normally both the same. This is so
  1402. * data can be read and written to different handlers */
  1403. BIO *rbio; /* used by SSL_read */
  1404. BIO *wbio; /* used by SSL_write */
  1405. BIO *bbio; /* used during session-id reuse to concatenate
  1406. * messages */
  1407. /* This holds a variable that indicates what we were doing when a 0 or -1 is
  1408. * returned. This is needed for non-blocking IO so we know what request
  1409. * needs re-doing when in SSL_accept or SSL_connect */
  1410. int rwstate;
  1411. /* true when we are actually in SSL_accept() or SSL_connect() */
  1412. int in_handshake;
  1413. int (*handshake_func)(SSL *);
  1414. /* Imagine that here's a boolean member "init" that is switched as soon as
  1415. * SSL_set_{accept/connect}_state is called for the first time, so that
  1416. * "state" and "handshake_func" are properly initialized. But as
  1417. * handshake_func is == 0 until then, we use this test instead of an "init"
  1418. * member. */
  1419. /* server is true iff the this SSL* is the server half. Note: before the SSL*
  1420. * is initialized by either SSL_set_accept_state or SSL_set_connect_state,
  1421. * the side is not determined. In this state, server is always false. */
  1422. int server;
  1423. /* quiet_shutdown is true if the connection should not send a close_notify on
  1424. * shutdown. */
  1425. int quiet_shutdown;
  1426. int shutdown; /* we have shut things down, 0x01 sent, 0x02
  1427. * for received */
  1428. int state; /* where we are */
  1429. BUF_MEM *init_buf; /* buffer used during init */
  1430. uint8_t *init_msg; /* pointer to handshake message body, set by
  1431. ssl3_get_message() */
  1432. int init_num; /* amount read/written */
  1433. int init_off; /* amount read/written */
  1434. struct ssl3_state_st *s3; /* SSLv3 variables */
  1435. struct dtls1_state_st *d1; /* DTLSv1 variables */
  1436. /* callback that allows applications to peek at protocol messages */
  1437. void (*msg_callback)(int write_p, int version, int content_type,
  1438. const void *buf, size_t len, SSL *ssl, void *arg);
  1439. void *msg_callback_arg;
  1440. int hit; /* reusing a previous session */
  1441. X509_VERIFY_PARAM *param;
  1442. /* crypto */
  1443. struct ssl_cipher_preference_list_st *cipher_list;
  1444. STACK_OF(SSL_CIPHER) *cipher_list_by_id;
  1445. SSL_AEAD_CTX *aead_read_ctx;
  1446. SSL_AEAD_CTX *aead_write_ctx;
  1447. /* session info */
  1448. /* client cert? */
  1449. /* This is used to hold the server certificate used */
  1450. struct cert_st /* CERT */ *cert;
  1451. /* the session_id_context is used to ensure sessions are only reused
  1452. * in the appropriate context */
  1453. unsigned int sid_ctx_length;
  1454. uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
  1455. /* This can also be in the session once a session is established */
  1456. SSL_SESSION *session;
  1457. /* Default generate session ID callback. */
  1458. GEN_SESSION_CB generate_session_id;
  1459. /* Used in SSL2 and SSL3 */
  1460. int verify_mode; /* 0 don't care about verify failure.
  1461. * 1 fail if verify fails */
  1462. int (*verify_callback)(int ok,
  1463. X509_STORE_CTX *ctx); /* fail if callback returns 0 */
  1464. void (*info_callback)(const SSL *ssl, int type,
  1465. int val); /* optional informational callback */
  1466. /* Server-only: psk_identity_hint is the identity hint to send in
  1467. * PSK-based key exchanges. */
  1468. char *psk_identity_hint;
  1469. unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
  1470. char *identity,
  1471. unsigned int max_identity_len,
  1472. uint8_t *psk, unsigned int max_psk_len);
  1473. unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
  1474. uint8_t *psk, unsigned int max_psk_len);
  1475. SSL_CTX *ctx;
  1476. /* extra application data */
  1477. long verify_result;
  1478. CRYPTO_EX_DATA ex_data;
  1479. /* for server side, keep the list of CA_dn we can use */
  1480. STACK_OF(X509_NAME) *client_CA;
  1481. uint32_t options; /* protocol behaviour */
  1482. uint32_t mode; /* API behaviour */
  1483. uint32_t max_cert_list;
  1484. int client_version; /* what was passed, used for
  1485. * SSLv3/TLS rollback check */
  1486. uint16_t max_send_fragment;
  1487. char *tlsext_hostname;
  1488. /* RFC4507 session ticket expected to be received or sent */
  1489. int tlsext_ticket_expected;
  1490. size_t tlsext_ellipticcurvelist_length;
  1491. uint16_t *tlsext_ellipticcurvelist; /* our list */
  1492. SSL_CTX *initial_ctx; /* initial ctx, used to store sessions */
  1493. /* Next protocol negotiation. For the client, this is the protocol that we
  1494. * sent in NextProtocol and is set when handling ServerHello extensions.
  1495. *
  1496. * For a server, this is the client's selected_protocol from NextProtocol and
  1497. * is set when handling the NextProtocol message, before the Finished
  1498. * message. */
  1499. uint8_t *next_proto_negotiated;
  1500. size_t next_proto_negotiated_len;
  1501. /* srtp_profiles is the list of configured SRTP protection profiles for
  1502. * DTLS-SRTP. */
  1503. STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
  1504. /* srtp_profile is the selected SRTP protection profile for
  1505. * DTLS-SRTP. */
  1506. const SRTP_PROTECTION_PROFILE *srtp_profile;
  1507. /* Copied from the SSL_CTX. For a server, means that we'll accept Channel IDs
  1508. * from clients. For a client, means that we'll advertise support. */
  1509. char tlsext_channel_id_enabled;
  1510. /* The client's Channel ID private key. */
  1511. EVP_PKEY *tlsext_channel_id_private;
  1512. /* Enable signed certificate time stamps. Currently client only. */
  1513. char signed_cert_timestamps_enabled;
  1514. /* ocsp_stapling_enabled is only used by client connections and indicates
  1515. * whether OCSP stapling will be requested. */
  1516. char ocsp_stapling_enabled;
  1517. /* For a client, this contains the list of supported protocols in wire
  1518. * format. */
  1519. uint8_t *alpn_client_proto_list;
  1520. unsigned alpn_client_proto_list_len;
  1521. /* accept_peer_renegotiations, if one, accepts renegotiation attempts from the
  1522. * peer. Otherwise, they will be rejected with a fatal error. */
  1523. char accept_peer_renegotiations;
  1524. /* These fields are always NULL and exist only to keep wpa_supplicant happy
  1525. * about the change to EVP_AEAD. They are only needed for EAP-FAST, which we
  1526. * don't support. */
  1527. EVP_CIPHER_CTX *enc_read_ctx;
  1528. EVP_MD_CTX *read_hash;
  1529. };
  1530. /* compatibility */
  1531. #define SSL_set_app_data(s, arg) (SSL_set_ex_data(s, 0, (char *)arg))
  1532. #define SSL_get_app_data(s) (SSL_get_ex_data(s, 0))
  1533. #define SSL_SESSION_set_app_data(s, a) \
  1534. (SSL_SESSION_set_ex_data(s, 0, (char *)a))
  1535. #define SSL_SESSION_get_app_data(s) (SSL_SESSION_get_ex_data(s, 0))
  1536. #define SSL_CTX_get_app_data(ctx) (SSL_CTX_get_ex_data(ctx, 0))
  1537. #define SSL_CTX_set_app_data(ctx, arg) \
  1538. (SSL_CTX_set_ex_data(ctx, 0, (char *)arg))
  1539. /* The following are the possible values for ssl->state are are used to
  1540. * indicate where we are up to in the SSL connection establishment. The macros
  1541. * that follow are about the only things you should need to use and even then,
  1542. * only when using non-blocking IO. It can also be useful to work out where you
  1543. * were when the connection failed */
  1544. #define SSL_ST_CONNECT 0x1000
  1545. #define SSL_ST_ACCEPT 0x2000
  1546. #define SSL_ST_MASK 0x0FFF
  1547. #define SSL_ST_INIT (SSL_ST_CONNECT | SSL_ST_ACCEPT)
  1548. #define SSL_ST_OK 0x03
  1549. #define SSL_ST_RENEGOTIATE (0x04 | SSL_ST_INIT)
  1550. #define SSL_CB_LOOP 0x01
  1551. #define SSL_CB_EXIT 0x02
  1552. #define SSL_CB_READ 0x04
  1553. #define SSL_CB_WRITE 0x08
  1554. #define SSL_CB_ALERT 0x4000 /* used in callback */
  1555. #define SSL_CB_READ_ALERT (SSL_CB_ALERT | SSL_CB_READ)
  1556. #define SSL_CB_WRITE_ALERT (SSL_CB_ALERT | SSL_CB_WRITE)
  1557. #define SSL_CB_ACCEPT_LOOP (SSL_ST_ACCEPT | SSL_CB_LOOP)
  1558. #define SSL_CB_ACCEPT_EXIT (SSL_ST_ACCEPT | SSL_CB_EXIT)
  1559. #define SSL_CB_CONNECT_LOOP (SSL_ST_CONNECT | SSL_CB_LOOP)
  1560. #define SSL_CB_CONNECT_EXIT (SSL_ST_CONNECT | SSL_CB_EXIT)
  1561. #define SSL_CB_HANDSHAKE_START 0x10
  1562. #define SSL_CB_HANDSHAKE_DONE 0x20
  1563. /* Is the SSL_connection established? */
  1564. #define SSL_get_state(a) SSL_state(a)
  1565. #define SSL_is_init_finished(a) (SSL_state(a) == SSL_ST_OK)
  1566. #define SSL_in_init(a) (SSL_state(a) & SSL_ST_INIT)
  1567. #define SSL_in_connect_init(a) (SSL_state(a) & SSL_ST_CONNECT)
  1568. #define SSL_in_accept_init(a) (SSL_state(a) & SSL_ST_ACCEPT)
  1569. /* SSL_in_false_start returns one if |s| has a pending unfinished handshake that
  1570. * is in False Start. |SSL_write| may be called at this point without waiting
  1571. * for the peer, but |SSL_read| will require the handshake to be completed. */
  1572. OPENSSL_EXPORT int SSL_in_false_start(const SSL *s);
  1573. /* Obtain latest Finished message
  1574. * -- that we sent (SSL_get_finished)
  1575. * -- that we expected from peer (SSL_get_peer_finished).
  1576. * Returns length (0 == no Finished so far), copies up to 'count' bytes. */
  1577. OPENSSL_EXPORT size_t SSL_get_finished(const SSL *s, void *buf, size_t count);
  1578. OPENSSL_EXPORT size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count);
  1579. /* use either SSL_VERIFY_NONE or SSL_VERIFY_PEER, the last 3 options
  1580. * are 'ored' with SSL_VERIFY_PEER if they are desired */
  1581. #define SSL_VERIFY_NONE 0x00
  1582. #define SSL_VERIFY_PEER 0x01
  1583. #define SSL_VERIFY_FAIL_IF_NO_PEER_CERT 0x02
  1584. /* SSL_VERIFY_CLIENT_ONCE does nothing. */
  1585. #define SSL_VERIFY_CLIENT_ONCE 0x04
  1586. #define SSL_VERIFY_PEER_IF_NO_OBC 0x08
  1587. #define OpenSSL_add_ssl_algorithms() SSL_library_init()
  1588. #define SSLeay_add_ssl_algorithms() SSL_library_init()
  1589. /* For backward compatibility */
  1590. #define SSL_get_cipher(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s))
  1591. #define SSL_get_cipher_bits(s, np) \
  1592. SSL_CIPHER_get_bits(SSL_get_current_cipher(s), np)
  1593. #define SSL_get_cipher_version(s) \
  1594. SSL_CIPHER_get_version(SSL_get_current_cipher(s))
  1595. #define SSL_get_cipher_name(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s))
  1596. #define SSL_get_time(a) SSL_SESSION_get_time(a)
  1597. #define SSL_set_time(a, b) SSL_SESSION_set_time((a), (b))
  1598. #define SSL_get_timeout(a) SSL_SESSION_get_timeout(a)
  1599. #define SSL_set_timeout(a, b) SSL_SESSION_set_timeout((a), (b))
  1600. #define d2i_SSL_SESSION_bio(bp, s_id) \
  1601. ASN1_d2i_bio_of(SSL_SESSION, SSL_SESSION_new, d2i_SSL_SESSION, bp, s_id)
  1602. #define i2d_SSL_SESSION_bio(bp, s_id) \
  1603. ASN1_i2d_bio_of(SSL_SESSION, i2d_SSL_SESSION, bp, s_id)
  1604. DECLARE_PEM_rw(SSL_SESSION, SSL_SESSION)
  1605. /* make_errors.go reserves error codes above 1000 for manually-assigned errors.
  1606. * This value must be kept in sync with reservedReasonCode in make_errors.h */
  1607. #define SSL_AD_REASON_OFFSET \
  1608. 1000 /* offset to get SSL_R_... value from SSL_AD_... */
  1609. /* These alert types are for SSLv3 and TLSv1 */
  1610. #define SSL_AD_CLOSE_NOTIFY SSL3_AD_CLOSE_NOTIFY
  1611. #define SSL_AD_UNEXPECTED_MESSAGE SSL3_AD_UNEXPECTED_MESSAGE /* fatal */
  1612. #define SSL_AD_BAD_RECORD_MAC SSL3_AD_BAD_RECORD_MAC /* fatal */
  1613. #define SSL_AD_DECRYPTION_FAILED TLS1_AD_DECRYPTION_FAILED
  1614. #define SSL_AD_RECORD_OVERFLOW TLS1_AD_RECORD_OVERFLOW
  1615. #define SSL_AD_DECOMPRESSION_FAILURE SSL3_AD_DECOMPRESSION_FAILURE /* fatal */
  1616. #define SSL_AD_HANDSHAKE_FAILURE SSL3_AD_HANDSHAKE_FAILURE /* fatal */
  1617. #define SSL_AD_NO_CERTIFICATE SSL3_AD_NO_CERTIFICATE /* Not for TLS */
  1618. #define SSL_AD_BAD_CERTIFICATE SSL3_AD_BAD_CERTIFICATE
  1619. #define SSL_AD_UNSUPPORTED_CERTIFICATE SSL3_AD_UNSUPPORTED_CERTIFICATE
  1620. #define SSL_AD_CERTIFICATE_REVOKED SSL3_AD_CERTIFICATE_REVOKED
  1621. #define SSL_AD_CERTIFICATE_EXPIRED SSL3_AD_CERTIFICATE_EXPIRED
  1622. #define SSL_AD_CERTIFICATE_UNKNOWN SSL3_AD_CERTIFICATE_UNKNOWN
  1623. #define SSL_AD_ILLEGAL_PARAMETER SSL3_AD_ILLEGAL_PARAMETER /* fatal */
  1624. #define SSL_AD_UNKNOWN_CA TLS1_AD_UNKNOWN_CA /* fatal */
  1625. #define SSL_AD_ACCESS_DENIED TLS1_AD_ACCESS_DENIED /* fatal */
  1626. #define SSL_AD_DECODE_ERROR TLS1_AD_DECODE_ERROR /* fatal */
  1627. #define SSL_AD_DECRYPT_ERROR TLS1_AD_DECRYPT_ERROR
  1628. #define SSL_AD_EXPORT_RESTRICTION TLS1_AD_EXPORT_RESTRICTION /* fatal */
  1629. #define SSL_AD_PROTOCOL_VERSION TLS1_AD_PROTOCOL_VERSION /* fatal */
  1630. #define SSL_AD_INSUFFICIENT_SECURITY TLS1_AD_INSUFFICIENT_SECURITY /* fatal */
  1631. #define SSL_AD_INTERNAL_ERROR TLS1_AD_INTERNAL_ERROR /* fatal */
  1632. #define SSL_AD_USER_CANCELLED TLS1_AD_USER_CANCELLED
  1633. #define SSL_AD_NO_RENEGOTIATION TLS1_AD_NO_RENEGOTIATION
  1634. #define SSL_AD_UNSUPPORTED_EXTENSION TLS1_AD_UNSUPPORTED_EXTENSION
  1635. #define SSL_AD_CERTIFICATE_UNOBTAINABLE TLS1_AD_CERTIFICATE_UNOBTAINABLE
  1636. #define SSL_AD_UNRECOGNIZED_NAME TLS1_AD_UNRECOGNIZED_NAME
  1637. #define SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE \
  1638. TLS1_AD_BAD_CERTIFICATE_STATUS_RESPONSE
  1639. #define SSL_AD_BAD_CERTIFICATE_HASH_VALUE TLS1_AD_BAD_CERTIFICATE_HASH_VALUE
  1640. #define SSL_AD_UNKNOWN_PSK_IDENTITY TLS1_AD_UNKNOWN_PSK_IDENTITY /* fatal */
  1641. #define SSL_AD_INAPPROPRIATE_FALLBACK SSL3_AD_INAPPROPRIATE_FALLBACK /* fatal */
  1642. #define SSL_ERROR_NONE 0
  1643. #define SSL_ERROR_SSL 1
  1644. #define SSL_ERROR_WANT_READ 2
  1645. #define SSL_ERROR_WANT_WRITE 3
  1646. #define SSL_ERROR_WANT_X509_LOOKUP 4
  1647. #define SSL_ERROR_SYSCALL 5 /* look at error stack/return value/errno */
  1648. #define SSL_ERROR_ZERO_RETURN 6
  1649. #define SSL_ERROR_WANT_CONNECT 7
  1650. #define SSL_ERROR_WANT_ACCEPT 8
  1651. #define SSL_ERROR_WANT_CHANNEL_ID_LOOKUP 9
  1652. #define SSL_ERROR_PENDING_SESSION 11
  1653. #define SSL_ERROR_PENDING_CERTIFICATE 12
  1654. #define SSL_ERROR_WANT_PRIVATE_KEY_OPERATION 13
  1655. /* DTLSv1_get_timeout queries the next DTLS handshake timeout. If there is a
  1656. * timeout in progress, it sets |*out| to the time remaining and returns one.
  1657. * Otherwise, it returns zero.
  1658. *
  1659. * When the timeout expires, call |DTLSv1_handle_timeout| to handle the
  1660. * retransmit behavior.
  1661. *
  1662. * NOTE: This function must be queried again whenever the handshake state
  1663. * machine changes, including when |DTLSv1_handle_timeout| is called. */
  1664. OPENSSL_EXPORT int DTLSv1_get_timeout(const SSL *ssl, struct timeval *out);
  1665. /* DTLSv1_handle_timeout is called when a DTLS handshake timeout expires. If no
  1666. * timeout had expired, it returns 0. Otherwise, it retransmits the previous
  1667. * flight of handshake messages and returns 1. If too many timeouts had expired
  1668. * without progress or an error occurs, it returns -1.
  1669. *
  1670. * NOTE: The caller's external timer should be compatible with the one |ssl|
  1671. * queries within some fudge factor. Otherwise, the call will be a no-op, but
  1672. * |DTLSv1_get_timeout| will return an updated timeout.
  1673. *
  1674. * WARNING: This function breaks the usual return value convention. */
  1675. OPENSSL_EXPORT int DTLSv1_handle_timeout(SSL *ssl);
  1676. /* SSL_session_reused returns one if |ssl| performed an abbreviated handshake
  1677. * and zero otherwise.
  1678. *
  1679. * TODO(davidben): Hammer down the semantics of this API while a handshake,
  1680. * initial or renego, is in progress. */
  1681. OPENSSL_EXPORT int SSL_session_reused(const SSL *ssl);
  1682. /* SSL_total_renegotiations returns the total number of renegotiation handshakes
  1683. * peformed by |ssl|. This includes the pending renegotiation, if any. */
  1684. OPENSSL_EXPORT int SSL_total_renegotiations(const SSL *ssl);
  1685. /* SSL_CTX_set_tmp_dh configures |ctx| to use the group from |dh| as the group
  1686. * for DHE. Only the group is used, so |dh| needn't have a keypair. It returns
  1687. * one on success and zero on error. */
  1688. OPENSSL_EXPORT int SSL_CTX_set_tmp_dh(SSL_CTX *ctx, const DH *dh);
  1689. /* SSL_set_tmp_dh configures |ssl| to use the group from |dh| as the group for
  1690. * DHE. Only the group is used, so |dh| needn't have a keypair. It returns one
  1691. * on success and zero on error. */
  1692. OPENSSL_EXPORT int SSL_set_tmp_dh(SSL *ssl, const DH *dh);
  1693. /* SSL_CTX_set_tmp_ecdh configures |ctx| to use the curve from |ecdh| as the
  1694. * curve for ephemeral ECDH keys. For historical reasons, this API expects an
  1695. * |EC_KEY|, but only the curve is used. It returns one on success and zero on
  1696. * error. If unset, an appropriate curve will be chosen automatically. (This is
  1697. * recommended.) */
  1698. OPENSSL_EXPORT int SSL_CTX_set_tmp_ecdh(SSL_CTX *ctx, const EC_KEY *ec_key);
  1699. /* SSL_set_tmp_ecdh configures |ssl| to use the curve from |ecdh| as the curve
  1700. * for ephemeral ECDH keys. For historical reasons, this API expects an
  1701. * |EC_KEY|, but only the curve is used. It returns one on success and zero on
  1702. * error. If unset, an appropriate curve will be chosen automatically. (This is
  1703. * recommended.) */
  1704. OPENSSL_EXPORT int SSL_set_tmp_ecdh(SSL *ssl, const EC_KEY *ec_key);
  1705. /* SSL_CTX_enable_tls_channel_id either configures a TLS server to accept TLS
  1706. * client IDs from clients, or configures a client to send TLS client IDs to
  1707. * a server. It returns one. */
  1708. OPENSSL_EXPORT int SSL_CTX_enable_tls_channel_id(SSL_CTX *ctx);
  1709. /* SSL_enable_tls_channel_id either configures a TLS server to accept TLS
  1710. * client IDs from clients, or configure a client to send TLS client IDs to
  1711. * server. It returns one. */
  1712. OPENSSL_EXPORT int SSL_enable_tls_channel_id(SSL *ssl);
  1713. /* SSL_CTX_set1_tls_channel_id configures a TLS client to send a TLS Channel ID
  1714. * to compatible servers. |private_key| must be a P-256 EC key. It returns one
  1715. * on success and zero on error. */
  1716. OPENSSL_EXPORT int SSL_CTX_set1_tls_channel_id(SSL_CTX *ctx,
  1717. EVP_PKEY *private_key);
  1718. /* SSL_set1_tls_channel_id configures a TLS client to send a TLS Channel ID to
  1719. * compatible servers. |private_key| must be a P-256 EC key. It returns one on
  1720. * success and zero on error. */
  1721. OPENSSL_EXPORT int SSL_set1_tls_channel_id(SSL *ssl, EVP_PKEY *private_key);
  1722. /* SSL_get_tls_channel_id gets the client's TLS Channel ID from a server SSL*
  1723. * and copies up to the first |max_out| bytes into |out|. The Channel ID
  1724. * consists of the client's P-256 public key as an (x,y) pair where each is a
  1725. * 32-byte, big-endian field element. It returns 0 if the client didn't offer a
  1726. * Channel ID and the length of the complete Channel ID otherwise. */
  1727. OPENSSL_EXPORT size_t SSL_get_tls_channel_id(SSL *ssl, uint8_t *out,
  1728. size_t max_out);
  1729. /* SSL_get0_certificate_types, for a client, sets |*out_types| to an array
  1730. * containing the client certificate types requested by a server. It returns the
  1731. * length of the array. */
  1732. OPENSSL_EXPORT size_t SSL_get0_certificate_types(SSL *ssl,
  1733. const uint8_t **out_types);
  1734. /* SSL_CTX_set1_curves sets the preferred curves for |ctx| to be |curves|. Each
  1735. * element of |curves| should be a curve nid. It returns one on success and
  1736. * zero on failure. */
  1737. OPENSSL_EXPORT int SSL_CTX_set1_curves(SSL_CTX *ctx, const int *curves,
  1738. size_t curves_len);
  1739. /* SSL_set1_curves sets the preferred curves for |ssl| to be |curves|. Each
  1740. * element of |curves| should be a curve nid. It returns one on success and
  1741. * zero on failure. */
  1742. OPENSSL_EXPORT int SSL_set1_curves(SSL *ssl, const int *curves,
  1743. size_t curves_len);
  1744. OPENSSL_EXPORT int SSL_CTX_set_cipher_list(SSL_CTX *, const char *str);
  1745. OPENSSL_EXPORT int SSL_CTX_set_cipher_list_tls11(SSL_CTX *, const char *str);
  1746. OPENSSL_EXPORT long SSL_CTX_set_timeout(SSL_CTX *ctx, long t);
  1747. OPENSSL_EXPORT long SSL_CTX_get_timeout(const SSL_CTX *ctx);
  1748. OPENSSL_EXPORT X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *);
  1749. OPENSSL_EXPORT void SSL_CTX_set_cert_store(SSL_CTX *, X509_STORE *);
  1750. OPENSSL_EXPORT int SSL_want(const SSL *s);
  1751. OPENSSL_EXPORT void SSL_CTX_flush_sessions(SSL_CTX *ctx, long tm);
  1752. /* SSL_get_current_cipher returns the cipher used in the current outgoing
  1753. * connection state, or NULL if the null cipher is active. */
  1754. OPENSSL_EXPORT const SSL_CIPHER *SSL_get_current_cipher(const SSL *s);
  1755. OPENSSL_EXPORT int SSL_get_fd(const SSL *s);
  1756. OPENSSL_EXPORT int SSL_get_rfd(const SSL *s);
  1757. OPENSSL_EXPORT int SSL_get_wfd(const SSL *s);
  1758. OPENSSL_EXPORT const char *SSL_get_cipher_list(const SSL *s, int n);
  1759. OPENSSL_EXPORT int SSL_pending(const SSL *s);
  1760. OPENSSL_EXPORT int SSL_set_fd(SSL *s, int fd);
  1761. OPENSSL_EXPORT int SSL_set_rfd(SSL *s, int fd);
  1762. OPENSSL_EXPORT int SSL_set_wfd(SSL *s, int fd);
  1763. OPENSSL_EXPORT void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio);
  1764. OPENSSL_EXPORT BIO *SSL_get_rbio(const SSL *s);
  1765. OPENSSL_EXPORT BIO *SSL_get_wbio(const SSL *s);
  1766. OPENSSL_EXPORT int SSL_set_cipher_list(SSL *s, const char *str);
  1767. OPENSSL_EXPORT int SSL_get_verify_mode(const SSL *s);
  1768. OPENSSL_EXPORT int SSL_get_verify_depth(const SSL *s);
  1769. OPENSSL_EXPORT int (*SSL_get_verify_callback(const SSL *s))(int,
  1770. X509_STORE_CTX *);
  1771. OPENSSL_EXPORT void SSL_set_verify(SSL *s, int mode,
  1772. int (*callback)(int ok,
  1773. X509_STORE_CTX *ctx));
  1774. OPENSSL_EXPORT void SSL_set_verify_depth(SSL *s, int depth);
  1775. OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file);
  1776. OPENSSL_EXPORT int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *
  1777. stackCAs,
  1778. const char *file);
  1779. OPENSSL_EXPORT int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *
  1780. stackCAs,
  1781. const char *dir);
  1782. /* SSL_load_error_strings does nothing. */
  1783. OPENSSL_EXPORT void SSL_load_error_strings(void);
  1784. OPENSSL_EXPORT const char *SSL_state_string(const SSL *s);
  1785. OPENSSL_EXPORT const char *SSL_state_string_long(const SSL *s);
  1786. OPENSSL_EXPORT long SSL_SESSION_get_time(const SSL_SESSION *s);
  1787. OPENSSL_EXPORT long SSL_SESSION_set_time(SSL_SESSION *s, long t);
  1788. OPENSSL_EXPORT long SSL_SESSION_get_timeout(const SSL_SESSION *s);
  1789. OPENSSL_EXPORT long SSL_SESSION_set_timeout(SSL_SESSION *s, long t);
  1790. /* SSL_SESSION_get_key_exchange_info returns a value that describes the
  1791. * strength of the asymmetric operation that provides confidentiality to
  1792. * |session|. Its interpretation depends on the operation used. See the
  1793. * documentation for this value in the |SSL_SESSION| structure. */
  1794. OPENSSL_EXPORT uint32_t SSL_SESSION_get_key_exchange_info(SSL_SESSION *session);
  1795. OPENSSL_EXPORT X509 *SSL_SESSION_get0_peer(SSL_SESSION *s);
  1796. OPENSSL_EXPORT int SSL_SESSION_set1_id_context(SSL_SESSION *s,
  1797. const uint8_t *sid_ctx,
  1798. unsigned int sid_ctx_len);
  1799. OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_new(void);
  1800. OPENSSL_EXPORT const uint8_t *SSL_SESSION_get_id(const SSL_SESSION *s,
  1801. unsigned int *len);
  1802. OPENSSL_EXPORT int SSL_SESSION_print_fp(FILE *fp, const SSL_SESSION *ses);
  1803. OPENSSL_EXPORT int SSL_SESSION_print(BIO *fp, const SSL_SESSION *ses);
  1804. /* SSL_SESSION_up_ref, if |session| is not NULL, increments the reference count
  1805. * of |session|. It then returns |session|. */
  1806. OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_up_ref(SSL_SESSION *session);
  1807. /* SSL_SESSION_free decrements the reference count of |session|. If it reaches
  1808. * zero, all data referenced by |session| and |session| itself are released. */
  1809. OPENSSL_EXPORT void SSL_SESSION_free(SSL_SESSION *session);
  1810. OPENSSL_EXPORT int SSL_set_session(SSL *to, SSL_SESSION *session);
  1811. OPENSSL_EXPORT int SSL_CTX_add_session(SSL_CTX *s, SSL_SESSION *c);
  1812. OPENSSL_EXPORT int SSL_CTX_remove_session(SSL_CTX *, SSL_SESSION *c);
  1813. OPENSSL_EXPORT int SSL_CTX_set_generate_session_id(SSL_CTX *, GEN_SESSION_CB);
  1814. OPENSSL_EXPORT int SSL_set_generate_session_id(SSL *, GEN_SESSION_CB);
  1815. OPENSSL_EXPORT int SSL_has_matching_session_id(const SSL *ssl,
  1816. const uint8_t *id,
  1817. unsigned int id_len);
  1818. /* SSL_SESSION_to_bytes serializes |in| into a newly allocated buffer and sets
  1819. * |*out_data| to that buffer and |*out_len| to its length. The caller takes
  1820. * ownership of the buffer and must call |OPENSSL_free| when done. It returns
  1821. * one on success and zero on error. */
  1822. OPENSSL_EXPORT int SSL_SESSION_to_bytes(SSL_SESSION *in, uint8_t **out_data,
  1823. size_t *out_len);
  1824. /* SSL_SESSION_to_bytes_for_ticket serializes |in|, but excludes the session
  1825. * identification information, namely the session ID and ticket. */
  1826. OPENSSL_EXPORT int SSL_SESSION_to_bytes_for_ticket(SSL_SESSION *in,
  1827. uint8_t **out_data,
  1828. size_t *out_len);
  1829. /* SSL_SESSION_from_bytes parses |in_len| bytes from |in| as an SSL_SESSION. It
  1830. * returns a newly-allocated |SSL_SESSION| on success or NULL on error. */
  1831. OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_from_bytes(const uint8_t *in,
  1832. size_t in_len);
  1833. /* Deprecated: i2d_SSL_SESSION serializes |in| to the bytes pointed to by
  1834. * |*pp|. On success, it returns the number of bytes written and advances |*pp|
  1835. * by that many bytes. On failure, it returns -1. If |pp| is NULL, no bytes are
  1836. * written and only the length is returned.
  1837. *
  1838. * Use |SSL_SESSION_to_bytes| instead. */
  1839. OPENSSL_EXPORT int i2d_SSL_SESSION(SSL_SESSION *in, uint8_t **pp);
  1840. /* Deprecated: d2i_SSL_SESSION parses a serialized session from the |length|
  1841. * bytes pointed to by |*pp|. It returns the new |SSL_SESSION| and advances
  1842. * |*pp| by the number of bytes consumed on success and NULL on failure. The
  1843. * caller takes ownership of the new session and must call |SSL_SESSION_free|
  1844. * when done.
  1845. *
  1846. * If |a| is non-NULL, |*a| is released and set the new |SSL_SESSION|.
  1847. *
  1848. * Use |SSL_SESSION_from_bytes| instead. */
  1849. OPENSSL_EXPORT SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const uint8_t **pp,
  1850. long length);
  1851. /* SSL_get_peer_certificate returns the peer's leaf certificate or NULL if the
  1852. * peer did not use certificates. The caller must call |X509_free| on the
  1853. * result to release it. */
  1854. OPENSSL_EXPORT X509 *SSL_get_peer_certificate(const SSL *ssl);
  1855. /* SSL_get_peer_cert_chain returns the peer's certificate chain or NULL if
  1856. * unavailable or the peer did not use certificates. For historical reasons,
  1857. * this may not be available if resuming a serialized |SSL_SESSION|. The caller
  1858. * does not take ownership of the result.
  1859. *
  1860. * WARNING: This function behaves differently between client and server. If
  1861. * |ssl| is a server, the returned chain does not include the leaf certificate.
  1862. * If a client, it does. */
  1863. OPENSSL_EXPORT STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *ssl);
  1864. OPENSSL_EXPORT int SSL_CTX_get_verify_mode(const SSL_CTX *ctx);
  1865. OPENSSL_EXPORT int SSL_CTX_get_verify_depth(const SSL_CTX *ctx);
  1866. OPENSSL_EXPORT int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx))(
  1867. int, X509_STORE_CTX *);
  1868. OPENSSL_EXPORT void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
  1869. int (*callback)(int, X509_STORE_CTX *));
  1870. OPENSSL_EXPORT void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth);
  1871. OPENSSL_EXPORT void SSL_CTX_set_cert_verify_callback(
  1872. SSL_CTX *ctx, int (*cb)(X509_STORE_CTX *, void *), void *arg);
  1873. OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx,
  1874. pem_password_cb *cb);
  1875. OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx,
  1876. void *u);
  1877. OPENSSL_EXPORT int SSL_CTX_set_session_id_context(SSL_CTX *ctx,
  1878. const uint8_t *sid_ctx,
  1879. unsigned int sid_ctx_len);
  1880. OPENSSL_EXPORT int SSL_set_session_id_context(SSL *ssl, const uint8_t *sid_ctx,
  1881. unsigned int sid_ctx_len);
  1882. OPENSSL_EXPORT int SSL_CTX_set_purpose(SSL_CTX *s, int purpose);
  1883. OPENSSL_EXPORT int SSL_set_purpose(SSL *s, int purpose);
  1884. OPENSSL_EXPORT int SSL_CTX_set_trust(SSL_CTX *s, int trust);
  1885. OPENSSL_EXPORT int SSL_set_trust(SSL *s, int trust);
  1886. OPENSSL_EXPORT int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm);
  1887. OPENSSL_EXPORT int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm);
  1888. OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx);
  1889. OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl);
  1890. OPENSSL_EXPORT int SSL_accept(SSL *ssl);
  1891. OPENSSL_EXPORT int SSL_connect(SSL *ssl);
  1892. OPENSSL_EXPORT int SSL_read(SSL *ssl, void *buf, int num);
  1893. OPENSSL_EXPORT int SSL_peek(SSL *ssl, void *buf, int num);
  1894. OPENSSL_EXPORT int SSL_write(SSL *ssl, const void *buf, int num);
  1895. OPENSSL_EXPORT int SSL_get_error(const SSL *s, int ret_code);
  1896. /* SSL_get_version returns a string describing the TLS version used by |s|. For
  1897. * example, "TLSv1.2" or "SSLv3". */
  1898. OPENSSL_EXPORT const char *SSL_get_version(const SSL *s);
  1899. /* SSL_SESSION_get_version returns a string describing the TLS version used by
  1900. * |sess|. For example, "TLSv1.2" or "SSLv3". */
  1901. OPENSSL_EXPORT const char *SSL_SESSION_get_version(const SSL_SESSION *sess);
  1902. /* SSL_get_curve_name returns a human-readable name for the elliptic curve
  1903. * specified by the given TLS curve id, or NULL if the curve if unknown. */
  1904. OPENSSL_EXPORT const char* SSL_get_curve_name(uint16_t curve_id);
  1905. OPENSSL_EXPORT STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s);
  1906. OPENSSL_EXPORT int SSL_do_handshake(SSL *s);
  1907. /* SSL_renegotiate_pending returns one if |ssl| is in the middle of a
  1908. * renegotiation. */
  1909. OPENSSL_EXPORT int SSL_renegotiate_pending(SSL *ssl);
  1910. OPENSSL_EXPORT int SSL_shutdown(SSL *s);
  1911. OPENSSL_EXPORT const char *SSL_alert_type_string_long(int value);
  1912. OPENSSL_EXPORT const char *SSL_alert_type_string(int value);
  1913. OPENSSL_EXPORT const char *SSL_alert_desc_string_long(int value);
  1914. OPENSSL_EXPORT const char *SSL_alert_desc_string(int value);
  1915. OPENSSL_EXPORT void SSL_set_client_CA_list(SSL *s,
  1916. STACK_OF(X509_NAME) *name_list);
  1917. OPENSSL_EXPORT void SSL_CTX_set_client_CA_list(SSL_CTX *ctx,
  1918. STACK_OF(X509_NAME) *name_list);
  1919. OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_get_client_CA_list(const SSL *s);
  1920. OPENSSL_EXPORT STACK_OF(X509_NAME) *
  1921. SSL_CTX_get_client_CA_list(const SSL_CTX *s);
  1922. OPENSSL_EXPORT int SSL_add_client_CA(SSL *ssl, X509 *x);
  1923. OPENSSL_EXPORT int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *x);
  1924. OPENSSL_EXPORT long SSL_get_default_timeout(const SSL *s);
  1925. OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_dup_CA_list(STACK_OF(X509_NAME) *sk);
  1926. OPENSSL_EXPORT void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);
  1927. OPENSSL_EXPORT int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);
  1928. OPENSSL_EXPORT void SSL_set_quiet_shutdown(SSL *ssl, int mode);
  1929. OPENSSL_EXPORT int SSL_get_quiet_shutdown(const SSL *ssl);
  1930. OPENSSL_EXPORT void SSL_set_shutdown(SSL *ssl, int mode);
  1931. OPENSSL_EXPORT int SSL_get_shutdown(const SSL *ssl);
  1932. OPENSSL_EXPORT int SSL_version(const SSL *ssl);
  1933. OPENSSL_EXPORT int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx);
  1934. OPENSSL_EXPORT int SSL_CTX_load_verify_locations(SSL_CTX *ctx,
  1935. const char *CAfile,
  1936. const char *CApath);
  1937. #define SSL_get0_session SSL_get_session /* just peek at pointer */
  1938. OPENSSL_EXPORT SSL_SESSION *SSL_get_session(const SSL *ssl);
  1939. OPENSSL_EXPORT SSL_SESSION *SSL_get1_session(
  1940. SSL *ssl); /* obtain a reference count */
  1941. OPENSSL_EXPORT SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl);
  1942. OPENSSL_EXPORT SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx);
  1943. OPENSSL_EXPORT void SSL_set_info_callback(SSL *ssl,
  1944. void (*cb)(const SSL *ssl, int type,
  1945. int val));
  1946. OPENSSL_EXPORT void (*SSL_get_info_callback(const SSL *ssl))(const SSL *ssl,
  1947. int type, int val);
  1948. OPENSSL_EXPORT int SSL_state(const SSL *ssl);
  1949. OPENSSL_EXPORT void SSL_set_verify_result(SSL *ssl, long v);
  1950. OPENSSL_EXPORT long SSL_get_verify_result(const SSL *ssl);
  1951. OPENSSL_EXPORT int SSL_set_ex_data(SSL *ssl, int idx, void *data);
  1952. OPENSSL_EXPORT void *SSL_get_ex_data(const SSL *ssl, int idx);
  1953. OPENSSL_EXPORT int SSL_get_ex_new_index(long argl, void *argp,
  1954. CRYPTO_EX_new *new_func,
  1955. CRYPTO_EX_dup *dup_func,
  1956. CRYPTO_EX_free *free_func);
  1957. OPENSSL_EXPORT int SSL_SESSION_set_ex_data(SSL_SESSION *ss, int idx,
  1958. void *data);
  1959. OPENSSL_EXPORT void *SSL_SESSION_get_ex_data(const SSL_SESSION *ss, int idx);
  1960. OPENSSL_EXPORT int SSL_SESSION_get_ex_new_index(long argl, void *argp,
  1961. CRYPTO_EX_new *new_func,
  1962. CRYPTO_EX_dup *dup_func,
  1963. CRYPTO_EX_free *free_func);
  1964. OPENSSL_EXPORT int SSL_CTX_set_ex_data(SSL_CTX *ssl, int idx, void *data);
  1965. OPENSSL_EXPORT void *SSL_CTX_get_ex_data(const SSL_CTX *ssl, int idx);
  1966. OPENSSL_EXPORT int SSL_CTX_get_ex_new_index(long argl, void *argp,
  1967. CRYPTO_EX_new *new_func,
  1968. CRYPTO_EX_dup *dup_func,
  1969. CRYPTO_EX_free *free_func);
  1970. OPENSSL_EXPORT int SSL_get_ex_data_X509_STORE_CTX_idx(void);
  1971. /* SSL_CTX_sess_set_cache_size sets the maximum size of |ctx|'s session cache to
  1972. * |size|. It returns the previous value. */
  1973. OPENSSL_EXPORT unsigned long SSL_CTX_sess_set_cache_size(SSL_CTX *ctx,
  1974. unsigned long size);
  1975. /* SSL_CTX_sess_get_cache_size returns the maximum size of |ctx|'s session
  1976. * cache. */
  1977. OPENSSL_EXPORT unsigned long SSL_CTX_sess_get_cache_size(const SSL_CTX *ctx);
  1978. /* SSL_SESS_CACHE_* are the possible session cache mode bits.
  1979. * TODO(davidben): Document. */
  1980. #define SSL_SESS_CACHE_OFF 0x0000
  1981. #define SSL_SESS_CACHE_CLIENT 0x0001
  1982. #define SSL_SESS_CACHE_SERVER 0x0002
  1983. #define SSL_SESS_CACHE_BOTH (SSL_SESS_CACHE_CLIENT | SSL_SESS_CACHE_SERVER)
  1984. #define SSL_SESS_CACHE_NO_AUTO_CLEAR 0x0080
  1985. #define SSL_SESS_CACHE_NO_INTERNAL_LOOKUP 0x0100
  1986. #define SSL_SESS_CACHE_NO_INTERNAL_STORE 0x0200
  1987. #define SSL_SESS_CACHE_NO_INTERNAL \
  1988. (SSL_SESS_CACHE_NO_INTERNAL_LOOKUP | SSL_SESS_CACHE_NO_INTERNAL_STORE)
  1989. /* SSL_CTX_set_session_cache_mode sets the session cache mode bits for |ctx| to
  1990. * |mode|. It returns the previous value. */
  1991. OPENSSL_EXPORT int SSL_CTX_set_session_cache_mode(SSL_CTX *ctx, int mode);
  1992. /* SSL_CTX_get_session_cache_mode returns the session cache mode bits for
  1993. * |ctx| */
  1994. OPENSSL_EXPORT int SSL_CTX_get_session_cache_mode(const SSL_CTX *ctx);
  1995. /* SSL_CTX_get_max_cert_list returns the maximum length, in bytes, of a peer
  1996. * certificate chain accepted by |ctx|. */
  1997. OPENSSL_EXPORT size_t SSL_CTX_get_max_cert_list(const SSL_CTX *ctx);
  1998. /* SSL_CTX_set_max_cert_list sets the maximum length, in bytes, of a peer
  1999. * certificate chain to |max_cert_list|. This affects how much memory may be
  2000. * consumed during the handshake. */
  2001. OPENSSL_EXPORT void SSL_CTX_set_max_cert_list(SSL_CTX *ctx,
  2002. size_t max_cert_list);
  2003. /* SSL_get_max_cert_list returns the maximum length, in bytes, of a peer
  2004. * certificate chain accepted by |ssl|. */
  2005. OPENSSL_EXPORT size_t SSL_get_max_cert_list(const SSL *ssl);
  2006. /* SSL_set_max_cert_list sets the maximum length, in bytes, of a peer
  2007. * certificate chain to |max_cert_list|. This affects how much memory may be
  2008. * consumed during the handshake. */
  2009. OPENSSL_EXPORT void SSL_set_max_cert_list(SSL *ssl, size_t max_cert_list);
  2010. /* SSL_CTX_set_max_send_fragment sets the maximum length, in bytes, of records
  2011. * sent by |ctx|. Beyond this length, handshake messages and application data
  2012. * will be split into multiple records. */
  2013. OPENSSL_EXPORT void SSL_CTX_set_max_send_fragment(SSL_CTX *ctx,
  2014. size_t max_send_fragment);
  2015. /* SSL_set_max_send_fragment sets the maximum length, in bytes, of records
  2016. * sent by |ssl|. Beyond this length, handshake messages and application data
  2017. * will be split into multiple records. */
  2018. OPENSSL_EXPORT void SSL_set_max_send_fragment(SSL *ssl,
  2019. size_t max_send_fragment);
  2020. /* SSL_CTX_set_tmp_dh_callback configures |ctx| to use |callback| to determine
  2021. * the group for DHE ciphers. |callback| should ignore |is_export| and
  2022. * |keylength| and return a |DH| of the selected group or NULL on error. Only
  2023. * the parameters are used, so the |DH| needn't have a generated keypair.
  2024. *
  2025. * WARNING: The caller does not take ownership of the resulting |DH|, so
  2026. * |callback| must save and release the object elsewhere. */
  2027. OPENSSL_EXPORT void SSL_CTX_set_tmp_dh_callback(
  2028. SSL_CTX *ctx, DH *(*callback)(SSL *ssl, int is_export, int keylength));
  2029. /* SSL_set_tmp_dh_callback configures |ssl| to use |callback| to determine the
  2030. * group for DHE ciphers. |callback| should ignore |is_export| and |keylength|
  2031. * and return a |DH| of the selected group or NULL on error. Only the
  2032. * parameters are used, so the |DH| needn't have a generated keypair.
  2033. *
  2034. * WARNING: The caller does not take ownership of the resulting |DH|, so
  2035. * |callback| must save and release the object elsewhere. */
  2036. OPENSSL_EXPORT void SSL_set_tmp_dh_callback(SSL *ssl,
  2037. DH *(*dh)(SSL *ssl, int is_export,
  2038. int keylength));
  2039. /* SSL_CTX_set_tmp_ecdh_callback configures |ctx| to use |callback| to determine
  2040. * the curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
  2041. * |keylength| and return an |EC_KEY| of the selected curve or NULL on
  2042. * error. Only the curve is used, so the |EC_KEY| needn't have a generated
  2043. * keypair.
  2044. *
  2045. * If the callback is unset, an appropriate curve will be chosen automatically.
  2046. * (This is recommended.)
  2047. *
  2048. * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
  2049. * |callback| must save and release the object elsewhere. */
  2050. OPENSSL_EXPORT void SSL_CTX_set_tmp_ecdh_callback(
  2051. SSL_CTX *ctx, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
  2052. /* SSL_set_tmp_ecdh_callback configures |ssl| to use |callback| to determine the
  2053. * curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
  2054. * |keylength| and return an |EC_KEY| of the selected curve or NULL on
  2055. * error. Only the curve is used, so the |EC_KEY| needn't have a generated
  2056. * keypair.
  2057. *
  2058. * If the callback is unset, an appropriate curve will be chosen automatically.
  2059. * (This is recommended.)
  2060. *
  2061. * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
  2062. * |callback| must save and release the object elsewhere. */
  2063. OPENSSL_EXPORT void SSL_set_tmp_ecdh_callback(
  2064. SSL *ssl, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
  2065. typedef void COMP_METHOD;
  2066. /* SSL_get_current_compression returns NULL. */
  2067. OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_compression(SSL *s);
  2068. /* SSL_get_current_expansion returns NULL. */
  2069. OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_expansion(SSL *s);
  2070. OPENSSL_EXPORT int SSL_cache_hit(SSL *s);
  2071. OPENSSL_EXPORT int SSL_is_server(SSL *s);
  2072. /* SSL_CTX_set_dos_protection_cb sets a callback that is called once the
  2073. * resumption decision for a ClientHello has been made. It can return 1 to
  2074. * allow the handshake to continue or zero to cause the handshake to abort. */
  2075. OPENSSL_EXPORT void SSL_CTX_set_dos_protection_cb(
  2076. SSL_CTX *ctx, int (*cb)(const struct ssl_early_callback_ctx *));
  2077. /* SSL_get_structure_sizes returns the sizes of the SSL, SSL_CTX and
  2078. * SSL_SESSION structures so that a test can ensure that outside code agrees on
  2079. * these values. */
  2080. OPENSSL_EXPORT void SSL_get_structure_sizes(size_t *ssl_size,
  2081. size_t *ssl_ctx_size,
  2082. size_t *ssl_session_size);
  2083. /* ERR_load_SSL_strings does nothing. */
  2084. OPENSSL_EXPORT void ERR_load_SSL_strings(void);
  2085. /* SSL_get_rc4_state sets |*read_key| and |*write_key| to the RC4 states for
  2086. * the read and write directions. It returns one on success or zero if |ssl|
  2087. * isn't using an RC4-based cipher suite. */
  2088. OPENSSL_EXPORT int SSL_get_rc4_state(const SSL *ssl, const RC4_KEY **read_key,
  2089. const RC4_KEY **write_key);
  2090. /* Deprecated functions. */
  2091. /* SSL_CIPHER_description writes a description of |cipher| into |buf| and
  2092. * returns |buf|. If |buf| is NULL, it returns a newly allocated string, to be
  2093. * freed with |OPENSSL_free|, or NULL on error.
  2094. *
  2095. * The description includes a trailing newline and has the form:
  2096. * AES128-SHA SSLv3 Kx=RSA Au=RSA Enc=AES(128) Mac=SHA1
  2097. *
  2098. * Consider |SSL_CIPHER_get_name| or |SSL_CIPHER_get_rfc_name| instead. */
  2099. OPENSSL_EXPORT const char *SSL_CIPHER_description(const SSL_CIPHER *cipher,
  2100. char *buf, int len);
  2101. /* SSL_CIPHER_get_version returns the string "TLSv1/SSLv3". */
  2102. OPENSSL_EXPORT const char *SSL_CIPHER_get_version(const SSL_CIPHER *cipher);
  2103. /* SSL_COMP_get_compression_methods returns NULL. */
  2104. OPENSSL_EXPORT COMP_METHOD *SSL_COMP_get_compression_methods(void);
  2105. /* SSL_COMP_add_compression_method returns one. */
  2106. OPENSSL_EXPORT int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm);
  2107. /* SSL_COMP_get_name returns NULL. */
  2108. OPENSSL_EXPORT const char *SSL_COMP_get_name(const COMP_METHOD *comp);
  2109. /* SSLv23_method calls |TLS_method|. */
  2110. OPENSSL_EXPORT const SSL_METHOD *SSLv23_method(void);
  2111. /* Version-specific methods behave exactly like |TLS_method| and |DTLS_method|
  2112. * except they also call |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version|
  2113. * to lock connections to that protocol version. */
  2114. OPENSSL_EXPORT const SSL_METHOD *SSLv3_method(void);
  2115. OPENSSL_EXPORT const SSL_METHOD *TLSv1_method(void);
  2116. OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_method(void);
  2117. OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_method(void);
  2118. OPENSSL_EXPORT const SSL_METHOD *DTLSv1_method(void);
  2119. OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_method(void);
  2120. /* Client- and server-specific methods call their corresponding generic
  2121. * methods. */
  2122. OPENSSL_EXPORT const SSL_METHOD *SSLv23_server_method(void);
  2123. OPENSSL_EXPORT const SSL_METHOD *SSLv23_client_method(void);
  2124. OPENSSL_EXPORT const SSL_METHOD *SSLv3_server_method(void);
  2125. OPENSSL_EXPORT const SSL_METHOD *SSLv3_client_method(void);
  2126. OPENSSL_EXPORT const SSL_METHOD *TLSv1_server_method(void);
  2127. OPENSSL_EXPORT const SSL_METHOD *TLSv1_client_method(void);
  2128. OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_server_method(void);
  2129. OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_client_method(void);
  2130. OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_server_method(void);
  2131. OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_client_method(void);
  2132. OPENSSL_EXPORT const SSL_METHOD *DTLS_server_method(void);
  2133. OPENSSL_EXPORT const SSL_METHOD *DTLS_client_method(void);
  2134. OPENSSL_EXPORT const SSL_METHOD *DTLSv1_server_method(void);
  2135. OPENSSL_EXPORT const SSL_METHOD *DTLSv1_client_method(void);
  2136. OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_server_method(void);
  2137. OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_client_method(void);
  2138. /* SSL_clear resets |ssl| to allow another connection and returns one on success
  2139. * or zero on failure. It returns most configuration state but releases memory
  2140. * associated with the current connection.
  2141. *
  2142. * Free |ssl| and create a new one instead. */
  2143. OPENSSL_EXPORT int SSL_clear(SSL *ssl);
  2144. /* SSL_CTX_set_tmp_rsa_callback does nothing. */
  2145. OPENSSL_EXPORT void SSL_CTX_set_tmp_rsa_callback(
  2146. SSL_CTX *ctx, RSA *(*cb)(SSL *ssl, int is_export, int keylength));
  2147. /* SSL_set_tmp_rsa_callback does nothing. */
  2148. OPENSSL_EXPORT void SSL_set_tmp_rsa_callback(SSL *ssl,
  2149. RSA *(*cb)(SSL *ssl, int is_export,
  2150. int keylength));
  2151. /* SSL_CTX_sess_connect returns zero. */
  2152. OPENSSL_EXPORT int SSL_CTX_sess_connect(const SSL_CTX *ctx);
  2153. /* SSL_CTX_sess_connect_good returns zero. */
  2154. OPENSSL_EXPORT int SSL_CTX_sess_connect_good(const SSL_CTX *ctx);
  2155. /* SSL_CTX_sess_connect_renegotiate returns zero. */
  2156. OPENSSL_EXPORT int SSL_CTX_sess_connect_renegotiate(const SSL_CTX *ctx);
  2157. /* SSL_CTX_sess_accept returns zero. */
  2158. OPENSSL_EXPORT int SSL_CTX_sess_accept(const SSL_CTX *ctx);
  2159. /* SSL_CTX_sess_accept_renegotiate returns zero. */
  2160. OPENSSL_EXPORT int SSL_CTX_sess_accept_renegotiate(const SSL_CTX *ctx);
  2161. /* SSL_CTX_sess_accept_good returns zero. */
  2162. OPENSSL_EXPORT int SSL_CTX_sess_accept_good(const SSL_CTX *ctx);
  2163. /* SSL_CTX_sess_hits returns zero. */
  2164. OPENSSL_EXPORT int SSL_CTX_sess_hits(const SSL_CTX *ctx);
  2165. /* SSL_CTX_sess_cb_hits returns zero. */
  2166. OPENSSL_EXPORT int SSL_CTX_sess_cb_hits(const SSL_CTX *ctx);
  2167. /* SSL_CTX_sess_misses returns zero. */
  2168. OPENSSL_EXPORT int SSL_CTX_sess_misses(const SSL_CTX *ctx);
  2169. /* SSL_CTX_sess_timeouts returns zero. */
  2170. OPENSSL_EXPORT int SSL_CTX_sess_timeouts(const SSL_CTX *ctx);
  2171. /* SSL_CTX_sess_cache_full returns zero. */
  2172. OPENSSL_EXPORT int SSL_CTX_sess_cache_full(const SSL_CTX *ctx);
  2173. /* SSL_cutthrough_complete calls |SSL_in_false_start|. */
  2174. OPENSSL_EXPORT int SSL_cutthrough_complete(const SSL *s);
  2175. /* SSL_num_renegotiations calls |SSL_total_renegotiations|. */
  2176. OPENSSL_EXPORT int SSL_num_renegotiations(const SSL *ssl);
  2177. /* SSL_CTX_need_tmp_RSA returns zero. */
  2178. OPENSSL_EXPORT int SSL_CTX_need_tmp_RSA(const SSL_CTX *ctx);
  2179. /* SSL_need_tmp_RSA returns zero. */
  2180. OPENSSL_EXPORT int SSL_need_tmp_RSA(const SSL *ssl);
  2181. /* SSL_CTX_set_tmp_rsa returns one. */
  2182. OPENSSL_EXPORT int SSL_CTX_set_tmp_rsa(SSL_CTX *ctx, const RSA *rsa);
  2183. /* SSL_set_tmp_rsa returns one. */
  2184. OPENSSL_EXPORT int SSL_set_tmp_rsa(SSL *ssl, const RSA *rsa);
  2185. /* SSL_CTX_get_read_ahead returns zero. */
  2186. OPENSSL_EXPORT int SSL_CTX_get_read_ahead(const SSL_CTX *ctx);
  2187. /* SSL_CTX_set_read_ahead does nothing. */
  2188. OPENSSL_EXPORT void SSL_CTX_set_read_ahead(SSL_CTX *ctx, int yes);
  2189. /* SSL_get_read_ahead returns zero. */
  2190. OPENSSL_EXPORT int SSL_get_read_ahead(const SSL *s);
  2191. /* SSL_set_read_ahead does nothing. */
  2192. OPENSSL_EXPORT void SSL_set_read_ahead(SSL *s, int yes);
  2193. /* SSL_renegotiate put an error on the error queue and returns zero. */
  2194. OPENSSL_EXPORT int SSL_renegotiate(SSL *ssl);
  2195. /* SSL_set_state does nothing. */
  2196. OPENSSL_EXPORT void SSL_set_state(SSL *ssl, int state);
  2197. /* Android compatibility section.
  2198. *
  2199. * These functions are declared, temporarily, for Android because
  2200. * wpa_supplicant will take a little time to sync with upstream. Outside of
  2201. * Android they'll have no definition. */
  2202. #define SSL_F_SSL_SET_SESSION_TICKET_EXT doesnt_exist
  2203. OPENSSL_EXPORT int SSL_set_session_ticket_ext(SSL *s, void *ext_data,
  2204. int ext_len);
  2205. OPENSSL_EXPORT int SSL_set_session_secret_cb(SSL *s, void *cb, void *arg);
  2206. OPENSSL_EXPORT int SSL_set_session_ticket_ext_cb(SSL *s, void *cb, void *arg);
  2207. OPENSSL_EXPORT int SSL_set_ssl_method(SSL *s, const SSL_METHOD *method);
  2208. #define OPENSSL_VERSION_TEXT "BoringSSL"
  2209. #define SSLEAY_VERSION 0
  2210. /* SSLeay_version is a compatibility function that returns the string
  2211. * "BoringSSL". */
  2212. OPENSSL_EXPORT const char *SSLeay_version(int unused);
  2213. /* Preprocessor compatibility section.
  2214. *
  2215. * Historically, a number of APIs were implemented in OpenSSL as macros and
  2216. * constants to 'ctrl' functions. To avoid breaking #ifdefs in consumers, this
  2217. * section defines a number of legacy macros.
  2218. *
  2219. * Although using either the CTRL values or their wrapper macros in #ifdefs is
  2220. * still supported, the CTRL values may not be passed to |SSL_ctrl| and
  2221. * |SSL_CTX_ctrl|. Call the functions (previously wrapper macros) instead. */
  2222. #define DTLS_CTRL_GET_TIMEOUT doesnt_exist
  2223. #define DTLS_CTRL_HANDLE_TIMEOUT doesnt_exist
  2224. #define SSL_CTRL_CHAIN doesnt_exist
  2225. #define SSL_CTRL_CHAIN_CERT doesnt_exist
  2226. #define SSL_CTRL_CHANNEL_ID doesnt_exist
  2227. #define SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS doesnt_exist
  2228. #define SSL_CTRL_CLEAR_MODE doesnt_exist
  2229. #define SSL_CTRL_CLEAR_OPTIONS doesnt_exist
  2230. #define SSL_CTRL_EXTRA_CHAIN_CERT doesnt_exist
  2231. #define SSL_CTRL_GET_CHAIN_CERTS doesnt_exist
  2232. #define SSL_CTRL_GET_CHANNEL_ID doesnt_exist
  2233. #define SSL_CTRL_GET_CLIENT_CERT_TYPES doesnt_exist
  2234. #define SSL_CTRL_GET_EXTRA_CHAIN_CERTS doesnt_exist
  2235. #define SSL_CTRL_GET_MAX_CERT_LIST doesnt_exist
  2236. #define SSL_CTRL_GET_NUM_RENEGOTIATIONS doesnt_exist
  2237. #define SSL_CTRL_GET_READ_AHEAD doesnt_exist
  2238. #define SSL_CTRL_GET_RI_SUPPORT doesnt_exist
  2239. #define SSL_CTRL_GET_SESSION_REUSED doesnt_exist
  2240. #define SSL_CTRL_GET_SESS_CACHE_MODE doesnt_exist
  2241. #define SSL_CTRL_GET_SESS_CACHE_SIZE doesnt_exist
  2242. #define SSL_CTRL_GET_TLSEXT_TICKET_KEYS doesnt_exist
  2243. #define SSL_CTRL_GET_TOTAL_RENEGOTIATIONS doesnt_exist
  2244. #define SSL_CTRL_MODE doesnt_exist
  2245. #define SSL_CTRL_NEED_TMP_RSA doesnt_exist
  2246. #define SSL_CTRL_OPTIONS doesnt_exist
  2247. #define SSL_CTRL_SESS_NUMBER doesnt_exist
  2248. #define SSL_CTRL_SET_CHANNEL_ID doesnt_exist
  2249. #define SSL_CTRL_SET_CURVES doesnt_exist
  2250. #define SSL_CTRL_SET_MAX_CERT_LIST doesnt_exist
  2251. #define SSL_CTRL_SET_MAX_SEND_FRAGMENT doesnt_exist
  2252. #define SSL_CTRL_SET_MSG_CALLBACK doesnt_exist
  2253. #define SSL_CTRL_SET_MSG_CALLBACK_ARG doesnt_exist
  2254. #define SSL_CTRL_SET_MTU doesnt_exist
  2255. #define SSL_CTRL_SET_READ_AHEAD doesnt_exist
  2256. #define SSL_CTRL_SET_SESS_CACHE_MODE doesnt_exist
  2257. #define SSL_CTRL_SET_SESS_CACHE_SIZE doesnt_exist
  2258. #define SSL_CTRL_SET_TLSEXT_HOSTNAME doesnt_exist
  2259. #define SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG doesnt_exist
  2260. #define SSL_CTRL_SET_TLSEXT_SERVERNAME_CB doesnt_exist
  2261. #define SSL_CTRL_SET_TLSEXT_TICKET_KEYS doesnt_exist
  2262. #define SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB doesnt_exist
  2263. #define SSL_CTRL_SET_TMP_DH doesnt_exist
  2264. #define SSL_CTRL_SET_TMP_DH_CB doesnt_exist
  2265. #define SSL_CTRL_SET_TMP_ECDH doesnt_exist
  2266. #define SSL_CTRL_SET_TMP_ECDH_CB doesnt_exist
  2267. #define SSL_CTRL_SET_TMP_RSA doesnt_exist
  2268. #define SSL_CTRL_SET_TMP_RSA_CB doesnt_exist
  2269. #define DTLSv1_get_timeout DTLSv1_get_timeout
  2270. #define DTLSv1_handle_timeout DTLSv1_handle_timeout
  2271. #define SSL_CTX_add0_chain_cert SSL_CTX_add0_chain_cert
  2272. #define SSL_CTX_add1_chain_cert SSL_CTX_add1_chain_cert
  2273. #define SSL_CTX_add_extra_chain_cert SSL_CTX_add_extra_chain_cert
  2274. #define SSL_CTX_clear_extra_chain_certs SSL_CTX_clear_extra_chain_certs
  2275. #define SSL_CTX_clear_chain_certs SSL_CTX_clear_chain_certs
  2276. #define SSL_CTX_clear_mode SSL_CTX_clear_mode
  2277. #define SSL_CTX_clear_options SSL_CTX_clear_options
  2278. #define SSL_CTX_enable_tls_channel_id SSL_CTX_enable_tls_channel_id
  2279. #define SSL_CTX_get0_chain_certs SSL_CTX_get0_chain_certs
  2280. #define SSL_CTX_get_extra_chain_certs SSL_CTX_get_extra_chain_certs
  2281. #define SSL_CTX_get_max_cert_list SSL_CTX_get_max_cert_list
  2282. #define SSL_CTX_get_mode SSL_CTX_get_mode
  2283. #define SSL_CTX_get_options SSL_CTX_get_options
  2284. #define SSL_CTX_get_read_ahead SSL_CTX_get_read_ahead
  2285. #define SSL_CTX_get_session_cache_mode SSL_CTX_get_session_cache_mode
  2286. #define SSL_CTX_get_tlsext_ticket_keys SSL_CTX_get_tlsext_ticket_keys
  2287. #define SSL_CTX_need_tmp_RSA SSL_CTX_need_tmp_RSA
  2288. #define SSL_CTX_sess_get_cache_size SSL_CTX_sess_get_cache_size
  2289. #define SSL_CTX_sess_number SSL_CTX_sess_number
  2290. #define SSL_CTX_sess_set_cache_size SSL_CTX_sess_set_cache_size
  2291. #define SSL_CTX_set0_chain SSL_CTX_set0_chain
  2292. #define SSL_CTX_set1_chain SSL_CTX_set1_chain
  2293. #define SSL_CTX_set1_curves SSL_CTX_set1_curves
  2294. #define SSL_CTX_set1_tls_channel_id SSL_CTX_set1_tls_channel_id
  2295. #define SSL_CTX_set_max_cert_list SSL_CTX_set_max_cert_list
  2296. #define SSL_CTX_set_max_send_fragment SSL_CTX_set_max_send_fragment
  2297. #define SSL_CTX_set_mode SSL_CTX_set_mode
  2298. #define SSL_CTX_set_msg_callback_arg SSL_CTX_set_msg_callback_arg
  2299. #define SSL_CTX_set_options SSL_CTX_set_options
  2300. #define SSL_CTX_set_read_ahead SSL_CTX_set_read_ahead
  2301. #define SSL_CTX_set_session_cache_mode SSL_CTX_set_session_cache_mode
  2302. #define SSL_CTX_set_tlsext_servername_arg SSL_CTX_set_tlsext_servername_arg
  2303. #define SSL_CTX_set_tlsext_servername_callback \
  2304. SSL_CTX_set_tlsext_servername_callback
  2305. #define SSL_CTX_set_tlsext_ticket_key_cb SSL_CTX_set_tlsext_ticket_key_cb
  2306. #define SSL_CTX_set_tlsext_ticket_keys SSL_CTX_set_tlsext_ticket_keys
  2307. #define SSL_CTX_set_tmp_dh SSL_CTX_set_tmp_dh
  2308. #define SSL_CTX_set_tmp_ecdh SSL_CTX_set_tmp_ecdh
  2309. #define SSL_CTX_set_tmp_rsa SSL_CTX_set_tmp_rsa
  2310. #define SSL_add0_chain_cert SSL_add0_chain_cert
  2311. #define SSL_add1_chain_cert SSL_add1_chain_cert
  2312. #define SSL_clear_chain_certs SSL_clear_chain_certs
  2313. #define SSL_clear_mode SSL_clear_mode
  2314. #define SSL_clear_options SSL_clear_options
  2315. #define SSL_enable_tls_channel_id SSL_enable_tls_channel_id
  2316. #define SSL_get0_certificate_types SSL_get0_certificate_types
  2317. #define SSL_get0_chain_certs SSL_get0_chain_certs
  2318. #define SSL_get_max_cert_list SSL_get_max_cert_list
  2319. #define SSL_get_mode SSL_get_mode
  2320. #define SSL_get_options SSL_get_options
  2321. #define SSL_get_secure_renegotiation_support \
  2322. SSL_get_secure_renegotiation_support
  2323. #define SSL_get_tls_channel_id SSL_get_tls_channel_id
  2324. #define SSL_need_tmp_RSA SSL_need_tmp_RSA
  2325. #define SSL_num_renegotiations SSL_num_renegotiations
  2326. #define SSL_session_reused SSL_session_reused
  2327. #define SSL_set0_chain SSL_set0_chain
  2328. #define SSL_set1_chain SSL_set1_chain
  2329. #define SSL_set1_curves SSL_set1_curves
  2330. #define SSL_set1_tls_channel_id SSL_set1_tls_channel_id
  2331. #define SSL_set_max_cert_list SSL_set_max_cert_list
  2332. #define SSL_set_max_send_fragment SSL_set_max_send_fragment
  2333. #define SSL_set_mode SSL_set_mode
  2334. #define SSL_set_msg_callback_arg SSL_set_msg_callback_arg
  2335. #define SSL_set_mtu SSL_set_mtu
  2336. #define SSL_set_options SSL_set_options
  2337. #define SSL_set_tlsext_host_name SSL_set_tlsext_host_name
  2338. #define SSL_set_tmp_dh SSL_set_tmp_dh
  2339. #define SSL_set_tmp_ecdh SSL_set_tmp_ecdh
  2340. #define SSL_set_tmp_rsa SSL_set_tmp_rsa
  2341. #define SSL_total_renegotiations SSL_total_renegotiations
  2342. #if defined(__cplusplus)
  2343. } /* extern C */
  2344. #endif
  2345. /* Library consumers assume these headers are included by ssl.h, but they depend
  2346. * on ssl.h, so include them after all declarations.
  2347. *
  2348. * TODO(davidben): The separation between ssl.h and these version-specific
  2349. * headers introduces circular dependencies and is inconsistent. The function
  2350. * declarations should move to ssl.h. Many of the constants can probably be
  2351. * pruned or unexported. */
  2352. #include <openssl/ssl3.h>
  2353. #include <openssl/tls1.h> /* This is mostly sslv3 with a few tweaks */
  2354. #include <openssl/srtp.h> /* Support for the use_srtp extension */
  2355. /* BEGIN ERROR CODES */
  2356. /* The following lines are auto generated by the script make_errors.go. Any
  2357. * changes made after this point may be overwritten when the script is next run.
  2358. */
  2359. #define SSL_R_APP_DATA_IN_HANDSHAKE 100
  2360. #define SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT 101
  2361. #define SSL_R_BAD_ALERT 102
  2362. #define SSL_R_BAD_CHANGE_CIPHER_SPEC 103
  2363. #define SSL_R_BAD_DATA_RETURNED_BY_CALLBACK 104
  2364. #define SSL_R_BAD_DH_P_LENGTH 105
  2365. #define SSL_R_BAD_DIGEST_LENGTH 106
  2366. #define SSL_R_BAD_ECC_CERT 107
  2367. #define SSL_R_BAD_ECPOINT 108
  2368. #define SSL_R_BAD_HANDSHAKE_LENGTH 109
  2369. #define SSL_R_BAD_HANDSHAKE_RECORD 110
  2370. #define SSL_R_BAD_HELLO_REQUEST 111
  2371. #define SSL_R_BAD_LENGTH 112
  2372. #define SSL_R_BAD_PACKET_LENGTH 113
  2373. #define SSL_R_BAD_RSA_ENCRYPT 114
  2374. #define SSL_R_BAD_SIGNATURE 115
  2375. #define SSL_R_BAD_SRTP_MKI_VALUE 116
  2376. #define SSL_R_BAD_SRTP_PROTECTION_PROFILE_LIST 117
  2377. #define SSL_R_BAD_SSL_FILETYPE 118
  2378. #define SSL_R_BAD_WRITE_RETRY 119
  2379. #define SSL_R_BIO_NOT_SET 120
  2380. #define SSL_R_BN_LIB 121
  2381. #define SSL_R_CANNOT_SERIALIZE_PUBLIC_KEY 122
  2382. #define SSL_R_CA_DN_LENGTH_MISMATCH 123
  2383. #define SSL_R_CA_DN_TOO_LONG 124
  2384. #define SSL_R_CCS_RECEIVED_EARLY 125
  2385. #define SSL_R_CERTIFICATE_VERIFY_FAILED 126
  2386. #define SSL_R_CERT_CB_ERROR 127
  2387. #define SSL_R_CERT_LENGTH_MISMATCH 128
  2388. #define SSL_R_CHANNEL_ID_NOT_P256 129
  2389. #define SSL_R_CHANNEL_ID_SIGNATURE_INVALID 130
  2390. #define SSL_R_CIPHER_CODE_WRONG_LENGTH 131
  2391. #define SSL_R_CIPHER_OR_HASH_UNAVAILABLE 132
  2392. #define SSL_R_CLIENTHELLO_PARSE_FAILED 133
  2393. #define SSL_R_CLIENTHELLO_TLSEXT 134
  2394. #define SSL_R_CONNECTION_REJECTED 135
  2395. #define SSL_R_CONNECTION_TYPE_NOT_SET 136
  2396. #define SSL_R_COOKIE_MISMATCH 137
  2397. #define SSL_R_D2I_ECDSA_SIG 138
  2398. #define SSL_R_DATA_BETWEEN_CCS_AND_FINISHED 139
  2399. #define SSL_R_DATA_LENGTH_TOO_LONG 140
  2400. #define SSL_R_DECODE_ERROR 141
  2401. #define SSL_R_DECRYPTION_FAILED 142
  2402. #define SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC 143
  2403. #define SSL_R_DH_PUBLIC_VALUE_LENGTH_IS_WRONG 144
  2404. #define SSL_R_DIGEST_CHECK_FAILED 145
  2405. #define SSL_R_DTLS_MESSAGE_TOO_BIG 146
  2406. #define SSL_R_ECC_CERT_NOT_FOR_SIGNING 147
  2407. #define SSL_R_EMPTY_SRTP_PROTECTION_PROFILE_LIST 148
  2408. #define SSL_R_ENCRYPTED_LENGTH_TOO_LONG 149
  2409. #define SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST 150
  2410. #define SSL_R_EVP_DIGESTSIGNFINAL_FAILED 151
  2411. #define SSL_R_EVP_DIGESTSIGNINIT_FAILED 152
  2412. #define SSL_R_EXCESSIVE_MESSAGE_SIZE 153
  2413. #define SSL_R_EXTRA_DATA_IN_MESSAGE 154
  2414. #define SSL_R_GOT_A_FIN_BEFORE_A_CCS 155
  2415. #define SSL_R_GOT_CHANNEL_ID_BEFORE_A_CCS 156
  2416. #define SSL_R_GOT_NEXT_PROTO_BEFORE_A_CCS 157
  2417. #define SSL_R_GOT_NEXT_PROTO_WITHOUT_EXTENSION 158
  2418. #define SSL_R_HANDSHAKE_FAILURE_ON_CLIENT_HELLO 159
  2419. #define SSL_R_HANDSHAKE_RECORD_BEFORE_CCS 160
  2420. #define SSL_R_HTTPS_PROXY_REQUEST 161
  2421. #define SSL_R_HTTP_REQUEST 162
  2422. #define SSL_R_INAPPROPRIATE_FALLBACK 163
  2423. #define SSL_R_INVALID_COMMAND 164
  2424. #define SSL_R_INVALID_MESSAGE 165
  2425. #define SSL_R_INVALID_SSL_SESSION 166
  2426. #define SSL_R_INVALID_TICKET_KEYS_LENGTH 167
  2427. #define SSL_R_LENGTH_MISMATCH 168
  2428. #define SSL_R_LIBRARY_HAS_NO_CIPHERS 169
  2429. #define SSL_R_MISSING_DH_KEY 170
  2430. #define SSL_R_MISSING_ECDSA_SIGNING_CERT 171
  2431. #define SSL_R_MISSING_RSA_CERTIFICATE 172
  2432. #define SSL_R_MISSING_RSA_ENCRYPTING_CERT 173
  2433. #define SSL_R_MISSING_RSA_SIGNING_CERT 174
  2434. #define SSL_R_MISSING_TMP_DH_KEY 175
  2435. #define SSL_R_MISSING_TMP_ECDH_KEY 176
  2436. #define SSL_R_MIXED_SPECIAL_OPERATOR_WITH_GROUPS 177
  2437. #define SSL_R_MTU_TOO_SMALL 178
  2438. #define SSL_R_NESTED_GROUP 179
  2439. #define SSL_R_NO_CERTIFICATES_RETURNED 180
  2440. #define SSL_R_NO_CERTIFICATE_ASSIGNED 181
  2441. #define SSL_R_NO_CERTIFICATE_SET 182
  2442. #define SSL_R_NO_CIPHERS_AVAILABLE 183
  2443. #define SSL_R_NO_CIPHERS_PASSED 184
  2444. #define SSL_R_NO_CIPHERS_SPECIFIED 185
  2445. #define SSL_R_NO_CIPHER_MATCH 186
  2446. #define SSL_R_NO_COMPRESSION_SPECIFIED 187
  2447. #define SSL_R_NO_METHOD_SPECIFIED 188
  2448. #define SSL_R_NO_P256_SUPPORT 189
  2449. #define SSL_R_NO_PRIVATE_KEY_ASSIGNED 190
  2450. #define SSL_R_NO_RENEGOTIATION 191
  2451. #define SSL_R_NO_REQUIRED_DIGEST 192
  2452. #define SSL_R_NO_SHARED_CIPHER 193
  2453. #define SSL_R_NO_SHARED_SIGATURE_ALGORITHMS 194
  2454. #define SSL_R_NO_SRTP_PROFILES 195
  2455. #define SSL_R_NULL_SSL_CTX 196
  2456. #define SSL_R_NULL_SSL_METHOD_PASSED 197
  2457. #define SSL_R_OLD_SESSION_CIPHER_NOT_RETURNED 198
  2458. #define SSL_R_PACKET_LENGTH_TOO_LONG 199
  2459. #define SSL_R_PARSE_TLSEXT 200
  2460. #define SSL_R_PATH_TOO_LONG 201
  2461. #define SSL_R_PEER_DID_NOT_RETURN_A_CERTIFICATE 202
  2462. #define SSL_R_PEER_ERROR_UNSUPPORTED_CERTIFICATE_TYPE 203
  2463. #define SSL_R_PROTOCOL_IS_SHUTDOWN 204
  2464. #define SSL_R_PSK_IDENTITY_NOT_FOUND 205
  2465. #define SSL_R_PSK_NO_CLIENT_CB 206
  2466. #define SSL_R_PSK_NO_SERVER_CB 207
  2467. #define SSL_R_READ_BIO_NOT_SET 208
  2468. #define SSL_R_READ_TIMEOUT_EXPIRED 209
  2469. #define SSL_R_RECORD_LENGTH_MISMATCH 210
  2470. #define SSL_R_RECORD_TOO_LARGE 211
  2471. #define SSL_R_RENEGOTIATE_EXT_TOO_LONG 212
  2472. #define SSL_R_RENEGOTIATION_ENCODING_ERR 213
  2473. #define SSL_R_RENEGOTIATION_MISMATCH 214
  2474. #define SSL_R_REQUIRED_CIPHER_MISSING 215
  2475. #define SSL_R_SCSV_RECEIVED_WHEN_RENEGOTIATING 216
  2476. #define SSL_R_SERVERHELLO_TLSEXT 217
  2477. #define SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED 218
  2478. #define SSL_R_SESSION_MAY_NOT_BE_CREATED 219
  2479. #define SSL_R_SIGNATURE_ALGORITHMS_ERROR 220
  2480. #define SSL_R_SRTP_COULD_NOT_ALLOCATE_PROFILES 221
  2481. #define SSL_R_SRTP_PROTECTION_PROFILE_LIST_TOO_LONG 222
  2482. #define SSL_R_SRTP_UNKNOWN_PROTECTION_PROFILE 223
  2483. #define SSL_R_SSL3_EXT_INVALID_SERVERNAME 224
  2484. #define SSL_R_SSL3_EXT_INVALID_SERVERNAME_TYPE 225
  2485. #define SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION 226
  2486. #define SSL_R_SSL_HANDSHAKE_FAILURE 227
  2487. #define SSL_R_SSL_SESSION_ID_CALLBACK_FAILED 228
  2488. #define SSL_R_SSL_SESSION_ID_CONFLICT 229
  2489. #define SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG 230
  2490. #define SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH 231
  2491. #define SSL_R_TLS_CLIENT_CERT_REQ_WITH_ANON_CIPHER 232
  2492. #define SSL_R_TLS_ILLEGAL_EXPORTER_LABEL 233
  2493. #define SSL_R_TLS_INVALID_ECPOINTFORMAT_LIST 234
  2494. #define SSL_R_TLS_PEER_DID_NOT_RESPOND_WITH_CERTIFICATE_LIST 235
  2495. #define SSL_R_TLS_RSA_ENCRYPTED_VALUE_LENGTH_IS_WRONG 236
  2496. #define SSL_R_TOO_MANY_EMPTY_FRAGMENTS 237
  2497. #define SSL_R_UNABLE_TO_FIND_ECDH_PARAMETERS 238
  2498. #define SSL_R_UNABLE_TO_FIND_PUBLIC_KEY_PARAMETERS 239
  2499. #define SSL_R_UNEXPECTED_GROUP_CLOSE 240
  2500. #define SSL_R_UNEXPECTED_MESSAGE 241
  2501. #define SSL_R_UNEXPECTED_OPERATOR_IN_GROUP 242
  2502. #define SSL_R_UNEXPECTED_RECORD 243
  2503. #define SSL_R_UNINITIALIZED 244
  2504. #define SSL_R_UNKNOWN_ALERT_TYPE 245
  2505. #define SSL_R_UNKNOWN_CERTIFICATE_TYPE 246
  2506. #define SSL_R_UNKNOWN_CIPHER_RETURNED 247
  2507. #define SSL_R_UNKNOWN_CIPHER_TYPE 248
  2508. #define SSL_R_UNKNOWN_DIGEST 249
  2509. #define SSL_R_UNKNOWN_KEY_EXCHANGE_TYPE 250
  2510. #define SSL_R_UNKNOWN_PROTOCOL 251
  2511. #define SSL_R_UNKNOWN_SSL_VERSION 252
  2512. #define SSL_R_UNKNOWN_STATE 253
  2513. #define SSL_R_UNPROCESSED_HANDSHAKE_DATA 254
  2514. #define SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED 255
  2515. #define SSL_R_UNSUPPORTED_CIPHER 256
  2516. #define SSL_R_UNSUPPORTED_COMPRESSION_ALGORITHM 257
  2517. #define SSL_R_UNSUPPORTED_ELLIPTIC_CURVE 258
  2518. #define SSL_R_UNSUPPORTED_PROTOCOL 259
  2519. #define SSL_R_UNSUPPORTED_SSL_VERSION 260
  2520. #define SSL_R_USE_SRTP_NOT_NEGOTIATED 261
  2521. #define SSL_R_WRONG_CERTIFICATE_TYPE 262
  2522. #define SSL_R_WRONG_CIPHER_RETURNED 263
  2523. #define SSL_R_WRONG_CURVE 264
  2524. #define SSL_R_WRONG_MESSAGE_TYPE 265
  2525. #define SSL_R_WRONG_SIGNATURE_TYPE 266
  2526. #define SSL_R_WRONG_SSL_VERSION 267
  2527. #define SSL_R_WRONG_VERSION_NUMBER 268
  2528. #define SSL_R_X509_LIB 269
  2529. #define SSL_R_X509_VERIFICATION_SETUP_PROBLEMS 270
  2530. #define SSL_R_FRAGMENT_MISMATCH 271
  2531. #define SSL_R_BUFFER_TOO_SMALL 272
  2532. #define SSL_R_OLD_SESSION_VERSION_NOT_RETURNED 273
  2533. #define SSL_R_OUTPUT_ALIASES_INPUT 274
  2534. #define SSL_R_RESUMED_EMS_SESSION_WITHOUT_EMS_EXTENSION 275
  2535. #define SSL_R_EMS_STATE_INCONSISTENT 276
  2536. #define SSL_R_RESUMED_NON_EMS_SESSION_WITH_EMS_EXTENSION 277
  2537. #define SSL_R_TOO_MANY_WARNING_ALERTS 278
  2538. #define SSL_R_UNEXPECTED_EXTENSION 279
  2539. #define SSL_R_SIGNATURE_ALGORITHMS_EXTENSION_SENT_BY_SERVER 280
  2540. #define SSL_R_ERROR_ADDING_EXTENSION 281
  2541. #define SSL_R_ERROR_PARSING_EXTENSION 282
  2542. #define SSL_R_MISSING_EXTENSION 283
  2543. #define SSL_R_CUSTOM_EXTENSION_CONTENTS_TOO_LARGE 284
  2544. #define SSL_R_CUSTOM_EXTENSION_ERROR 285
  2545. #define SSL_R_SSLV3_ALERT_CLOSE_NOTIFY 1000
  2546. #define SSL_R_SSLV3_ALERT_UNEXPECTED_MESSAGE 1010
  2547. #define SSL_R_SSLV3_ALERT_BAD_RECORD_MAC 1020
  2548. #define SSL_R_TLSV1_ALERT_DECRYPTION_FAILED 1021
  2549. #define SSL_R_TLSV1_ALERT_RECORD_OVERFLOW 1022
  2550. #define SSL_R_SSLV3_ALERT_DECOMPRESSION_FAILURE 1030
  2551. #define SSL_R_SSLV3_ALERT_HANDSHAKE_FAILURE 1040
  2552. #define SSL_R_SSLV3_ALERT_NO_CERTIFICATE 1041
  2553. #define SSL_R_SSLV3_ALERT_BAD_CERTIFICATE 1042
  2554. #define SSL_R_SSLV3_ALERT_UNSUPPORTED_CERTIFICATE 1043
  2555. #define SSL_R_SSLV3_ALERT_CERTIFICATE_REVOKED 1044
  2556. #define SSL_R_SSLV3_ALERT_CERTIFICATE_EXPIRED 1045
  2557. #define SSL_R_SSLV3_ALERT_CERTIFICATE_UNKNOWN 1046
  2558. #define SSL_R_SSLV3_ALERT_ILLEGAL_PARAMETER 1047
  2559. #define SSL_R_TLSV1_ALERT_UNKNOWN_CA 1048
  2560. #define SSL_R_TLSV1_ALERT_ACCESS_DENIED 1049
  2561. #define SSL_R_TLSV1_ALERT_DECODE_ERROR 1050
  2562. #define SSL_R_TLSV1_ALERT_DECRYPT_ERROR 1051
  2563. #define SSL_R_TLSV1_ALERT_EXPORT_RESTRICTION 1060
  2564. #define SSL_R_TLSV1_ALERT_PROTOCOL_VERSION 1070
  2565. #define SSL_R_TLSV1_ALERT_INSUFFICIENT_SECURITY 1071
  2566. #define SSL_R_TLSV1_ALERT_INTERNAL_ERROR 1080
  2567. #define SSL_R_TLSV1_ALERT_INAPPROPRIATE_FALLBACK 1086
  2568. #define SSL_R_TLSV1_ALERT_USER_CANCELLED 1090
  2569. #define SSL_R_TLSV1_ALERT_NO_RENEGOTIATION 1100
  2570. #define SSL_R_TLSV1_UNSUPPORTED_EXTENSION 1110
  2571. #define SSL_R_TLSV1_CERTIFICATE_UNOBTAINABLE 1111
  2572. #define SSL_R_TLSV1_UNRECOGNIZED_NAME 1112
  2573. #define SSL_R_TLSV1_BAD_CERTIFICATE_STATUS_RESPONSE 1113
  2574. #define SSL_R_TLSV1_BAD_CERTIFICATE_HASH_VALUE 1114
  2575. #endif /* OPENSSL_HEADER_SSL_H */