VirtualBox

Changeset 57577 in vbox for trunk/include


Ignore:
Timestamp:
Aug 28, 2015 6:57:36 PM (10 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
102405
Message:

IPRT,QtGui: Redid the certificate download code in the GUI and reduced the number of unnecessary wrapper methods. Removed RTHttpCertDigest, adding RTHttpFreeResponse and RTHttpFreeResponseText. Also added RTCrPemParseContent.

Location:
trunk/include/iprt
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/iprt/crypto/pem.h

    r57572 r57577  
    102102
    103103/**
    104  * Frees sections returned by RTCrPemReadFile.
     104 * Frees sections returned by RTCrPemReadFile and RTCrPemParseContent.
    105105 * @returns IPRT status code.
    106106 * @param   pSectionHead        The first section.
    107107 */
    108108RTDECL(int) RTCrPemFreeSections(PCRTCRPEMSECTION pSectionHead);
     109
     110/**
     111 * Parses the given data and returns a list of binary sections.
     112 *
     113 * If the file isn't an ASCII file or if no markers were found, the entire file
     114 * content is returned as one single section (with pMarker = NULL).
     115 *
     116 * @returns IPRT status code.
     117 * @retval  VINF_EOF if the file is empty. The ppSectionHead value will be NULL.
     118 *
     119 * @param   pvContent       The content bytes to parse.
     120 * @param   cbContent       The number of content bytes.
     121 * @param   fFlags          RTCRPEMREADFILE_F_XXX.
     122 * @param   paMarkers       Array of one or more section markers to look for.
     123 * @param   cMarkers        Number of markers in the array.
     124 * @param   ppSectionHead   Where to return the head of the section list.  Call
     125 *                          RTCrPemFreeSections to free.
     126 * @param   pErrInfo        Where to return extend error info. Optional.
     127 */
     128RTDECL(int) RTCrPemParseContent(void const *pvContent, size_t cbContent, uint32_t fFlags,
     129                                PCRTCRPEMMARKER paMarkers, size_t cMarkers, PCRTCRPEMSECTION *ppSectionHead, PRTERRINFO pErrInfo);
    109130
    110131/**
    … …  
    116137 *
    117138 * @returns IPRT status code.
     139 * @retval  VINF_EOF if the file is empty. The ppSectionHead value will be NULL.
     140 *
    118141 * @param   pszFilename     The path to the file to read.
    119142 * @param   fFlags          RTCRPEMREADFILE_F_XXX.
    120143 * @param   paMarkers       Array of one or more section markers to look for.
    121144 * @param   cMarkers        Number of markers in the array.
    122  * @param   ppSectionHead   Where to return the head of the section list.
     145 * @param   ppSectionHead   Where to return the head of the section list. Call
     146 *                          RTCrPemFreeSections to free.
    123147 * @param   pErrInfo        Where to return extend error info. Optional.
    124148 */
    125149RTDECL(int) RTCrPemReadFile(const char *pszFilename, uint32_t fFlags, PCRTCRPEMMARKER paMarkers, size_t cMarkers,
    126150                            PCRTCRPEMSECTION *ppSectionHead, PRTERRINFO pErrInfo);
    127 /** @name RTCRPEMREADFILE_F_XXX - Flags for RTCrPemReadFile
     151/** @name RTCRPEMREADFILE_F_XXX - Flags for RTCrPemReadFile and
     152 *        RTCrPemParseContent.
    128153 * @{ */
    129154/** Continue on encoding error. */

  • trunk/include/iprt/http.h

    r56291 r57577  
    6666 * Retrieve the redir location for 301 responses.
    6767 *
    68  * @param   hHttp       Handle to the HTTP interface.
    69  * @para    ppszRedirLocation   Where to store the string. To be freed with
     68 * @param   hHttp               Handle to the HTTP interface.
     69 * @param   ppszRedirLocation   Where to store the string. To be freed with
    7070 *                              RTStrFree().
    7171 */
    … …  
    7575 * Perform a simple blocking HTTP request.
    7676 *
    77  * @returns iprt status code.
    78  *
    79  * @param    hHttp         HTTP interface handle.
    80  * @param    pcszUrl       URL.
    81  * @param    ppszResponse  HTTP response. It is guaranteed that this string is
    82  *                         '\0'-terminated.
    83  */
    84 RTR3DECL(int) RTHttpGetText(RTHTTP hHttp, const char *pcszUrl, char **ppszResponse);
     77 * This is a just a convenient wrapper around RTHttpGetBinary that returns a
     78 * different type and sheds a parameter.
     79 *
     80 * @returns iprt status code.
     81 *
     82 * @param   hHttp           HTTP interface handle.
     83 * @param   pcszUrl         URL.
     84 * @param   ppszNotUtf8     Where to return the poitner to the HTTP response.
     85 *                          The string is of course zero terminated.  Use
     86 *                          RTHttpFreeReponseText to free.
     87 *
     88 * @remarks BIG FAT WARNING!
     89 *
     90 *          This function does not guarantee the that returned string is valid UTF-8 or
     91 *          any other kind of text encoding!
     92 *
     93 *          The caller must determine and validate the string encoding _before_
     94 *          passing it along to functions that expect UTF-8!
     95 *
     96 *          Also, this function does not guarantee that the returned string
     97 *          doesn't have embedded zeros and provides the caller no way of
     98 *          finding out!  If you are worried about the response from the HTTPD
     99 *          containing embedded zero's, use RTHttpGetBinary instead.
     100 */
     101RTR3DECL(int) RTHttpGetText(RTHTTP hHttp, const char *pcszUrl, char **ppszNotUtf8);
     102
     103/**
     104 * Frees memory returned by RTHttpGetText.
     105 *
     106 * @param   pszNotUtf8      What RTHttpGetText returned.
     107 */
     108RTR3DECL(void) RTHttpFreeResponseText(char *pszNotUtf8);
    85109
    86110/**
    … …  
    89113 * @returns iprt status code.
    90114 *
    91  * @param    hHttp         HTTP interface handle.
    92  * @param    pcszUrl       URL.
    93  * @param    ppvResponse   HTTP response.
    94  * @param    pcb           Size of the returned buffer.
     115 * @param   hHttp           HTTP interface handle.
     116 * @param   pcszUrl         The URL.
     117 * @param   ppvResponse     Where to store the HTTP response data.  Use
     118 *                          RTHttpFreeResponse to free.
     119 * @param   pcb             Size of the returned buffer.
    95120 */
    96121RTR3DECL(int) RTHttpGetBinary(RTHTTP hHttp, const char *pcszUrl, void **ppvResponse, size_t *pcb);
    97122
    98123/**
     124 * Frees memory returned by RTHttpGetBinary.
     125 *
     126 * @param   pvResponse      What RTHttpGetBinary returned.
     127 */
     128RTR3DECL(void) RTHttpFreeResponse(void *pvResponse);
     129
     130/**
    99131 * Perform a simple blocking HTTP request, writing the output to a file.
    100132 *
    … …  
    102134 *
    103135 * @param   hHttp           HTTP interface handle.
    104  * @param   pszUrl          URL.
     136 * @param   pszUrl          The URL.
    105137 * @param   pszDstFile      The destination file name.
    106138 */
    … …  
    114146 * @returns iprt status code.
    115147 *
    116  * @param    hHttp         HTTP interface handle.
     148 * @param   hHttp           HTTP interface handle.
    117149 */
    118150RTR3DECL(int) RTHttpAbort(RTHTTP hHttp);
    … …  
    131163 * @returns iprt status code.
    132164 *
    133  * @param    hHttp         HTTP interface handle.
    134  * @param    pcszProxy     URL of the proxy
    135  * @param    uPort         port number of the proxy, use 0 for not specifying a port.
    136  * @param    pcszUser      username, pass NULL for no authentication
    137  * @param    pcszPwd       password, pass NULL for no authentication
     165 * @param   hHttp           HTTP interface handle.
     166 * @param   pcszProxy       URL of the proxy.
     167 * @param   uPort           port number of the proxy, use 0 for not specifying a port.
     168 * @param   pcszUser        Username, pass NULL for no authentication.
     169 * @param   pcszPwd         Password, pass NULL for no authentication.
    138170 */
    139171RTR3DECL(int) RTHttpSetProxy(RTHTTP hHttp, const char *pcszProxyUrl, uint32_t uPort,
    … …  
    145177 * @returns iprt status code.
    146178 *
    147  * @param    hHttp         HTTP interface handle.
    148  * @param    cHeaders      number of custom headers.
    149  * @param    pcszHeaders   array of headers in form "foo: bar".
     179 * @param   hHttp           HTTP interface handle.
     180 * @param   cHeaders        Number of custom headers.
     181 * @param   pcszHeaders     Array of headers in form "foo: bar".
    150182 */
    151183RTR3DECL(int) RTHttpSetHeaders(RTHTTP hHttp, size_t cHeaders, const char * const *papszHeaders);
    … …  
    156188 * @returns iprt status code.
    157189 *
    158  * @param    hHttp         HTTP interface handle.
    159  * @param    pcszCAFile    File name containing root certificates.
     190 * @param   hHttp           HTTP interface handle.
     191 * @param   pcszCAFile      File name containing root certificates.
    160192 */
    161193RTR3DECL(int) RTHttpSetCAFile(RTHTTP hHttp, const char *pcszCAFile);
    162194
    163195
    164 /**
    165  * Determine the digest (fingerprint) of a certificate. Allocate memory for
    166  * storing the SHA1 fingerprint as well as the SHA512 fingerprint. This
    167  * memory has to be freed by RTMemFree().
    168  *
    169  * @todo Move this function to somewhere else.
    170  *
    171  * @returns iprt status code.
    172  *
    173  * @param    hHttp         HTTP interface handle (ignored).
    174  * @param    pcszCert      The certificate in PEM format.
    175  * @param    cbCert        Size of the certificate.
    176  * @param    pabSha1       Where to store the pointer to the SHA1 fingerprint.
    177  * @param    pcbSha1       Where to store the size of the SHA1 fingerprint.
    178  * @param    pabSha512     Where to store the pointer to the SHA512 fingerprint.
    179  * @param    pcbSha512     Where to store the size of the SHA512 fingerprint.
    180  */
    181 RTR3DECL(int) RTHttpCertDigest(RTHTTP hHttp, char *pcszCert, size_t cbCert,
    182                                uint8_t **pabSha1, size_t *pcbSha1,
    183                                uint8_t **pabSha512, size_t *pcbSha512);
    184 
    185 
    186196/** @} */
    187197

  • trunk/include/iprt/mangling.h

    r57572 r57577  
    24332433# define RTCrRsaPublicKey_CheckSanity                   RT_MANGLER(RTCrRsaPublicKey_CheckSanity)
    24342434# define RTCrPemFreeSections                            RT_MANGLER(RTCrPemFreeSections)
     2435# define RTCrPemParseContent                            RT_MANGLER(RTCrPemParseContent)
    24352436# define RTCrPemReadFile                                RT_MANGLER(RTCrPemReadFile)
    24362437# define RTCrPkcs7Attribute_DecodeAsn1                  RT_MANGLER(RTCrPkcs7Attribute_DecodeAsn1)
Note: See TracChangeset for help on using the changeset viewer.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette