mirror of
				https://github.com/cuberite/polarssl.git
				synced 2025-11-04 04:32:24 -05:00 
			
		
		
		
	Improve documentation of mbedtls_pem_write_buffer()
In particular, mention that it supports overlapping input and output buffers.
This commit is contained in:
		
							parent
							
								
									def4305168
								
							
						
					
					
						commit
						4063ad22b3
					
				@ -112,17 +112,27 @@ void mbedtls_pem_free( mbedtls_pem_context *ctx );
 | 
				
			|||||||
 * \brief           Write a buffer of PEM information from a DER encoded
 | 
					 * \brief           Write a buffer of PEM information from a DER encoded
 | 
				
			||||||
 *                  buffer.
 | 
					 *                  buffer.
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * \param header    header string to write
 | 
					 * \param header    The header string to write.
 | 
				
			||||||
 * \param footer    footer string to write
 | 
					 * \param footer    The footer string to write.
 | 
				
			||||||
 * \param der_data  DER data to write
 | 
					 * \param der_data  The DER data to encode.
 | 
				
			||||||
 * \param der_len   length of the DER data
 | 
					 * \param der_len   The length of the DER data \p der_data in Bytes.
 | 
				
			||||||
 * \param buf       buffer to write to
 | 
					 * \param buf       The buffer to write to.
 | 
				
			||||||
 * \param buf_len   length of output buffer
 | 
					 * \param buf_len   The length of the output buffer \p buf in Bytes.
 | 
				
			||||||
 * \param olen      total length written / required (if buf_len is not enough)
 | 
					 * \param olen      The address at which to store the total length written
 | 
				
			||||||
 | 
					 *                  or required (if \p buf_len is not enough).
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * \return          0 on success, or a specific PEM or BASE64 error code. On
 | 
					 * \note            You may pass \c NULL for \p buf and \c 0 for \p buf_len
 | 
				
			||||||
 *                  MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL olen is the required
 | 
					 *                  to request the length of the resulting PEM buffer in
 | 
				
			||||||
 *                  size.
 | 
					 *                  `*olen`.
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * \note            This function may be called with overlapping \p der_data
 | 
				
			||||||
 | 
					 *                  and \p buf buffers.
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * \return          \c 0 on success.
 | 
				
			||||||
 | 
					 * \return          #MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL if \p buf isn't large
 | 
				
			||||||
 | 
					 *                  enough to hold the PEM buffer. In  this case, `*olen` holds
 | 
				
			||||||
 | 
					 *                  the required minimum size of \p buf.
 | 
				
			||||||
 | 
					 * \return          Another PEM or BASE64 error code on other kinds of failure.
 | 
				
			||||||
 */
 | 
					 */
 | 
				
			||||||
int mbedtls_pem_write_buffer( const char *header, const char *footer,
 | 
					int mbedtls_pem_write_buffer( const char *header, const char *footer,
 | 
				
			||||||
                      const unsigned char *der_data, size_t der_len,
 | 
					                      const unsigned char *der_data, size_t der_len,
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user