doc/manpages/gnutls_priority_init.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_priority_init" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_priority_init \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "int gnutls_priority_init(gnutls_priority_t * " priority_cache ", const char * " priorities ", const char ** " err_pos ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_priority_t * priority_cache" 12
  11 is a \fBgnutls_prioritity_t\fP structure.
  12 .IP "const char * priorities" 12
  13 is a string describing priorities
  14 .IP "const char ** err_pos" 12
  15 In case of an error this will have the position in the string the error occured
  16 .SH "DESCRIPTION"
  17 Sets priorities for the ciphers, key exchange methods, macs and
  18 compression methods.
  19
  20 The \fBpriorities\fP option allows you to specify a colon
  21 separated list of the cipher priorities to enable.
  22 .SH "COMMON KEYWORDS"
  23 Some keywords are defined to provide quick access
  24 to common preferences.
  25
  26 "PERFORMANCE" means all the "secure" ciphersuites are enabled,
  27 limited to 128 bit ciphers and sorted by terms of speed
  28 performance.
  29
  30 "NORMAL" means all "secure" ciphersuites. The 256\-bit ciphers are
  31 included as a fallback only.  The ciphers are sorted by security
  32 margin.
  33
  34 "SECURE128" means all "secure" ciphersuites with ciphers up to 128
  35 bits, sorted by security margin.
  36
  37 "SECURE256" means all "secure" ciphersuites including the 256 bit
  38 ciphers, sorted by security margin.
  39
  40 "EXPORT" means all ciphersuites are enabled, including the
  41 low\-security 40 bit ciphers.
  42
  43 "NONE" means nothing is enabled.  This disables even protocols and
  44 compression methods.
  45 .SH "SPECIAL KEYWORDS"
  46 "!" or "\-" appended with an algorithm will remove this algorithm.
  47
  48 "+" appended with an algorithm will add this algorithm.
  49
  50 Check the GnuTLS manual section "Priority strings" for detailed
  51 information.
  52 .SH "EXAMPLES"
  53
  54 "NONE:+VERS\-TLS\-ALL:+MAC\-ALL:+RSA:+AES\-128\-CBC:+SIGN\-ALL:+COMP\-NULL"
  55
  56 "NORMAL:\-ARCFOUR\-128" means normal ciphers except for ARCFOUR\-128.
  57
  58 "SECURE:\-VERS\-SSL3.0:+COMP\-DEFLATE" means that only secure ciphers are
  59 enabled, SSL3.0 is disabled, and libz compression enabled.
  60
  61 "NONE:+VERS\-TLS\-ALL:+AES\-128\-CBC:+RSA:+SHA1:+COMP\-NULL:+SIGN\-RSA\-SHA1",
  62
  63 "NORMAL:\fBCOMPAT\fP" is the most compatible mode.
  64 .SH "RETURNS"
  65 On syntax error \fBGNUTLS_E_INVALID_REQUEST\fP is returned,
  66 \fBGNUTLS_E_SUCCESS\fP on success, or an error code.
  67 .SH "REPORTING BUGS"
  68 Report bugs to <bug-gnutls@gnu.org>.
  69 GnuTLS home page: http://www.gnu.org/software/gnutls/
  70 General help using GNU software: http://www.gnu.org/gethelp/
  71 .SH COPYRIGHT
  72 Copyright \(co 2008 Free Software Foundation.
  73 .br
  74 Copying and distribution of this file, with or without modification,
  75 are permitted in any medium without royalty provided the copyright
  76 notice and this notice are preserved.
  77 .SH "SEE ALSO"
  78 The full documentation for
  79 .B gnutls
  80 is maintained as a Texinfo manual.  If the
  81 .B info
  82 and
  83 .B gnutls
  84 programs are properly installed at your site, the command
  85 .IP
  86 .B info gnutls
  87 .PP
  88 should give you access to the complete manual.