docs/api.mdwn
changeset 61 745b73f91607
parent 50 2278dd806ad3
child 62 d92358eafead
equal deleted inserted replaced
60:1dbd1898058f 61:745b73f91607
   499 <a name="lm.ssl.new"></a>
   499 <a name="lm.ssl.new"></a>
   500 ### lm.ssl.new
   500 ### lm.ssl.new
   501 Creates new ssl object for use with connection.
   501 Creates new ssl object for use with connection.
   502 You can specify server key fingerprint, callback function for error handling,
   502 You can specify server key fingerprint, callback function for error handling,
   503 both, or neither. Though, fingerprint should go before callback function.
   503 both, or neither. Though, fingerprint should go before callback function.
   504 SSL fingerprint is a string like '01:23:45:67:89:AB:CD:EF:FE:DC:BA:98:76:54:32:10'.  
   504 SSL fingerprint is a string like 'SHA256:ABCDEF123456...' (or
       
   505 '01:23:45:67:89:AB:CD:EF:FE:DC:BA:98:76:54:32:10' for LM versions, older than 1.5.3).  
   505 **Arguments:** string (optional ssl fingerprint), [ssl callback function](#ssl.callback.function) (optional)    
   506 **Arguments:** string (optional ssl fingerprint), [ssl callback function](#ssl.callback.function) (optional)    
   506 **Return values:** userdata ([lm ssl](#lm.ssl) object)  
   507 **Return values:** userdata ([lm ssl](#lm.ssl) object)  
   507 
   508 
   508 <a name="lm.ssl.bless"></a>
   509 <a name="lm.ssl.bless"></a>
   509 ### lm.ssl.bless
   510 ### lm.ssl.bless
   511 **Arguments:** lightuserdata (C [lm ssl](#lm.ssl) object)    
   512 **Arguments:** lightuserdata (C [lm ssl](#lm.ssl) object)    
   512 **Return values:** userdata ([lm ssl](#lm.ssl) object)  
   513 **Return values:** userdata ([lm ssl](#lm.ssl) object)  
   513 
   514 
   514 <a name="lm.ssl.supported"></a>
   515 <a name="lm.ssl.supported"></a>
   515 ### lm.ssl.supported
   516 ### lm.ssl.supported
   516 Indicates if SSL is supported by loudmouth library.  
   517 Indicates if SSL is supported by loudmouth library and what kind of
   517 **Return values:** boolean  
   518 ssl fingerprint is used.  
       
   519 **Return values:** nil or string ("MD5" or "SHA256")  
       
   520 
       
   521 <a name="ssl:ca.path"></a>
       
   522 ### ssl:ca_path
       
   523 Set path to trusted ssl certificates. Argument must be a name of a PEM file
       
   524 or a name of directory with hashed certificates.  
       
   525 **Arguments:** string (path)  
       
   526 
       
   527 <a name="ssl:cipher.list"></a>
       
   528 ### ssl:cipher_list
       
   529 Set list of allowed ciphers (colon-separated). Names may vary depending on ssl
       
   530 implementation in use.  
       
   531 **Arguments:** string (cipher list)  
   518 
   532 
   519 <a name="ssl:fingerprint"></a>
   533 <a name="ssl:fingerprint"></a>
   520 ### ssl:fingerprint
   534 ### ssl:fingerprint
   521 Returns fingerprint of remote server.  
   535 Returns fingerprint of remote server.  
   522 **Return values:** string or nil  
   536 **Return values:** string or nil