githubmirror/xmlsec

src/io.c
642 строки20 KB
lsh123
Update file headers for doxygen, use common copyright header, bump copyright to 2026 (#1122)
07 апр 2026, 04:13
07 апр 2026, 04:132e557ee
/**
 * XML Security Library (http://www.aleksey.com/xmlsec).
 *
 * This is free software; see the Copyright file in the source distribution for precise wording.
 *
 * Copyright (C) 2002-2026 Aleksey Sanin <aleksey@aleksey.com>. All Rights Reserved.
 */
/**
 * @addtogroup xmlsec_core_io
 * @brief Input/output functions.
 */
#include "globals.h"

#include <stdlib.h>
#include <string.h>

#include <libxml/uri.h>
#include <libxml/tree.h>
#include <libxml/xmlIO.h>

/* check if we want HTTP and FTP support */
#ifndef LIBXML_HTTP_ENABLED
#define XMLSEC_NO_HTTP  1
#endif /* LIBXML_HTTP_ENABLED */

#ifndef LIBXML_FTP_ENABLED
#define XMLSEC_NO_FTP  1
#endif /* LIBXML_FTP_ENABLED */

#ifndef XMLSEC_NO_HTTP
#include <libxml/nanohttp.h>
#endif /* XMLSEC_NO_HTTP */

#ifndef XMLSEC_NO_FTP
#include <libxml/nanoftp.h>
#endif /* XMLSEC_NO_FTP */

#include <xmlsec/xmlsec.h>
#include <xmlsec/keys.h>
#include <xmlsec/transforms.h>
#include <xmlsec/keys.h>
#include <xmlsec/io.h>
#include <xmlsec/errors.h>
#include <xmlsec/xmltree.h>

#include "cast_helpers.h"

/******************************************************************************
 *
 * Input I/O callback sets
 *
  *****************************************************************************/
typedef struct _xmlSecIOCallback {
    xmlInputMatchCallback matchcallback;
    xmlInputOpenCallback opencallback;
    xmlInputReadCallback readcallback;
    xmlInputCloseCallback closecallback;
} xmlSecIOCallback, *xmlSecIOCallbackPtr;

static xmlSecIOCallbackPtr      xmlSecIOCallbackCreate  (xmlInputMatchCallback matchFunc,
                                                         xmlInputOpenCallback openFunc,
                                                         xmlInputReadCallback readFunc,
                                                         xmlInputCloseCallback closeFunc);
static void                     xmlSecIOCallbackDestroy (void *callbacks);

static xmlSecIOCallbackPtr
xmlSecIOCallbackCreate(xmlInputMatchCallback matchFunc, xmlInputOpenCallback openFunc,
                       xmlInputReadCallback readFunc, xmlInputCloseCallback closeFunc) {
    xmlSecIOCallbackPtr callbacks;

    xmlSecAssert2(matchFunc != NULL, NULL);

    /* Allocate a new xmlSecIOCallback and fill the fields. */
    callbacks = (xmlSecIOCallbackPtr)xmlMalloc(sizeof(xmlSecIOCallback));
    if(callbacks == NULL) {
        xmlSecMallocError(sizeof(xmlSecIOCallback), NULL);
        return(NULL);
    }
    memset(callbacks, 0, sizeof(xmlSecIOCallback));

    callbacks->matchcallback = matchFunc;
    callbacks->opencallback  = openFunc;
    callbacks->readcallback  = readFunc;
    callbacks->closecallback = closeFunc;

    return(callbacks);
}

static void
xmlSecIOCallbackDestroy(void* callbacks) {
    xmlSecAssert(callbacks != NULL);

    memset(callbacks, 0, sizeof(xmlSecIOCallback));
    xmlFree(callbacks);
}

/******************************************************************************
 *
 * Input I/O callback list
 *
  *****************************************************************************/
static xmlSecPtrListKlass xmlSecIOCallbackPtrListKlass = {
    BAD_CAST "io-callbacks-list",
    NULL,                       /* xmlSecPtrDuplicateItemMethod duplicateItem; */
    xmlSecIOCallbackDestroy,    /* xmlSecPtrDestroyItemMethod destroyItem; */
    NULL,                       /* xmlSecPtrDebugDumpItemMethod debugDumpItem; */
    NULL                        /* xmlSecPtrDebugDumpItemMethod debugXmlDumpItem; */
};

#define xmlSecIOCallbackPtrListId       xmlSecIOCallbackPtrListGetKlass ()
static xmlSecPtrListId                  xmlSecIOCallbackPtrListGetKlass (void);
static xmlSecIOCallbackPtr              xmlSecIOCallbackPtrListFind     (xmlSecPtrListPtr list,
                                                                         const char* uri);

/**
 * @brief The keys list klass.
 * @return keys list id.
 */
static xmlSecPtrListId
xmlSecIOCallbackPtrListGetKlass(void) {
    return(&xmlSecIOCallbackPtrListKlass);
}

static xmlSecIOCallbackPtr
xmlSecIOCallbackPtrListFind(xmlSecPtrListPtr list, const char* uri) {
    xmlSecIOCallbackPtr callbacks;
    xmlSecSize i, size;

    xmlSecAssert2(xmlSecPtrListCheckId(list, xmlSecIOCallbackPtrListId), NULL);
    xmlSecAssert2(uri != NULL, NULL);

    /* Search from the end of the list to ensure the newly added entries are picked up first */
    size = xmlSecPtrListGetSize(list);
    for(i = size; i > 0; --i) {
        callbacks = (xmlSecIOCallbackPtr)xmlSecPtrListGetItem(list, i - 1);
        xmlSecAssert2(callbacks != NULL, NULL);
        xmlSecAssert2(callbacks->matchcallback != NULL, NULL);

        if((callbacks->matchcallback(uri)) != 0) {
            return(callbacks);
        }
    }
    return(NULL);
}

static xmlSecPtrList xmlSecAllIOCallbacks;

/**
 * @brief Initializes the IO subsystem.
 * @details The IO initialization (called from #xmlSecInit function).
 * Applications should not call this function directly.
 * @return 0 on success or a negative value otherwise.
 */
int
xmlSecIOInit(void) {
    int ret;

    ret = xmlSecPtrListInitialize(&xmlSecAllIOCallbacks, xmlSecIOCallbackPtrListId);
    if(ret < 0) {
        xmlSecInternalError("xmlSecPtrListInitialize", NULL);
        return(-1);
    }

#ifndef XMLSEC_NO_FTP
    xmlNanoFTPInit();
#endif /* XMLSEC_NO_FTP */

#ifndef XMLSEC_NO_HTTP
    xmlNanoHTTPInit();
#endif /* #ifndef XMLSEC_NO_HTTP
 */

    ret = xmlSecIORegisterDefaultCallbacks();
    if(ret < 0) {
        xmlSecInternalError("xmlSecIORegisterDefaultCallbacks", NULL);
        return(-1);
    }

    return(0);
}

/**
 * @brief Shuts down the IO subsystem.
 * @details The IO cleanup (called from #xmlSecShutdown function).
 * Applications should not call this function directly.
 */
void
xmlSecIOShutdown(void) {

#ifndef XMLSEC_NO_HTTP
    xmlNanoHTTPCleanup();
#endif /* XMLSEC_NO_HTTP */

#ifndef XMLSEC_NO_FTP
    xmlNanoFTPCleanup();
#endif /* XMLSEC_NO_FTP */

    xmlSecPtrListFinalize(&xmlSecAllIOCallbacks);
}

/**
 * @brief Clears all input callbacks.
 * @details Clears the entire input callback table. this includes the
 * compiled-in I/O.
 */
void
xmlSecIOCleanupCallbacks(void) {
    xmlSecPtrListEmpty(&xmlSecAllIOCallbacks);
}

/**
 * @brief Registers I/O callbacks for parser input.
 * @details Register a new set of I/O callback for handling parser input.
 * @param matchFunc the protocol match callback.
 * @param openFunc the open stream callback.
 * @param readFunc the read from stream callback.
 * @param closeFunc the close stream callback.
 * @return the 0 on success or a negative value if an error occurs.
 */
int
xmlSecIORegisterCallbacks(xmlInputMatchCallback matchFunc,
        xmlInputOpenCallback openFunc, xmlInputReadCallback readFunc,
        xmlInputCloseCallback closeFunc) {
    xmlSecIOCallbackPtr callbacks;
    int ret;

    xmlSecAssert2(matchFunc != NULL, -1);

    callbacks = xmlSecIOCallbackCreate(matchFunc, openFunc, readFunc, closeFunc);
    if(callbacks == NULL) {
        xmlSecInternalError("xmlSecIOCallbackCreate", NULL);
        return(-1);
    }

    ret = xmlSecPtrListAdd(&xmlSecAllIOCallbacks, callbacks);
    if(ret < 0) {
        xmlSecInternalError("xmlSecPtrListAdd", NULL);
        xmlSecIOCallbackDestroy(callbacks);
        return(-1);
    }
    return(0);
}

/** File IO **/
static int
xmlSecIOFileExtractFilename(char const* filename, char** out) {
    const char* escaped;
    char* unescaped = NULL;

    xmlSecAssert2(filename != NULL, -1);

    if (!xmlStrncasecmp(BAD_CAST filename, BAD_CAST "file://localhost/", 17)) {
        escaped = &filename[16];
    } else if (!xmlStrncasecmp(BAD_CAST filename, BAD_CAST "file:///", 8)) {
        escaped = &filename[7];
    } else if (!xmlStrncasecmp(BAD_CAST filename, BAD_CAST "file://", 7)) {
        /* lots of generators seems to lazy to read RFC 1738 */
        escaped = &filename[6];
    } else if (!xmlStrncasecmp(BAD_CAST filename, BAD_CAST "file:/", 6)) {
        /* lots of generators seems to lazy to read RFC 1738 */
        escaped = &filename[5];
    } else {
        (*out) = NULL;
        return(0); /* hope for the best */
    }

#ifdef _WIN32
    /* Ignore slash like in file:///C:/file.txt */
    escaped += 1;
#endif

    unescaped = xmlURIUnescapeString(escaped, 0, NULL);
    if (unescaped == NULL) {
        xmlSecXmlError("xmlURIUnescapeString", NULL);
        return(-1);
    }

    /* done */
    (*out) = unescaped;
    return(0);
}


static int
xmlSecIOFileMatch(char const* filename) {
    xmlSecAssert2(filename != NULL, -1);
    return(1); /* hope for the best */
}

static void*
xmlSecIOFileOpen(char const* filename) {
    char* tmp = NULL;
    FILE* fd = NULL;
    int ret;

    xmlSecAssert2(filename != NULL, NULL);

    /* extract the filename */
    ret = xmlSecIOFileExtractFilename(filename, &tmp);
    if (ret < 0) {
        xmlSecInternalError("xmlSecIOFileExtractFilename", NULL);
        return(NULL);
    }
    if (tmp != NULL) {
        filename = tmp;
    }

    /* open file */
#if defined(XMLSEC_WINDOWS) && defined(UNICODE)
    {
        LPTSTR wpath;
        errno_t err;

        wpath = xmlSecWin32ConvertUtf8ToTstr(BAD_CAST filename);
        if (wpath == NULL) {
            xmlSecInternalError("xmlSecWin32ConvertUtf8ToTstr", NULL);
            xmlFree(tmp);
            return(NULL);
        }
        err = _wfopen_s(&fd, wpath, L"rb");
        if ((err != 0) || (fd == NULL)) {
            xmlSecInternalError("_wfopen_s", NULL);
            xmlFree(wpath);
            xmlFree(tmp);
            return(NULL);
        }
        xmlFree(wpath);
    }
#elif defined(XMLSEC_WINDOWS)
    {
        errno_t err;
        err = fopen_s(&fd, filename, "rb");
        if ((err != 0) || (fd == NULL)) {
            xmlSecInternalError("fopen_s", NULL);
            xmlFree(tmp);
            return(NULL);
        }
    }
#else /* defined(XMLSEC_WINDOWS) && defined(UNICODE) */
    fd = fopen(filename, "rb");
    if (fd == NULL) {
        xmlSecInternalError("fopen", NULL);
        xmlFree(tmp);
        return(NULL);
    }
#endif /* defined(XMLSEC_WINDOWS) && defined(UNICODE) */

    /* done */
    xmlFree(tmp);
    return(fd);
}

static int
xmlSecIOFileRead(void* context, char* buffer, int len) {
    FILE* fd = (FILE*)context;
    size_t szLen, szBytes;
    int res;

    xmlSecAssert2(fd != NULL, -1);
    xmlSecAssert2(buffer != NULL, -1);

    XMLSEC_SAFE_CAST_INT_TO_SIZE(len, szLen, return(-1), NULL);

    szBytes = fread(buffer, 1, szLen, fd);
    if ((szBytes < szLen) && (ferror(fd))) {
        xmlSecInternalError("fread", NULL);
        return(-1);
    }

    XMLSEC_SAFE_CAST_SIZE_TO_INT(szBytes, res, return(-1), NULL);
    return(res);
}

static int
xmlSecIOFilClose(void* context) {
    FILE* fd = (FILE*)context;
    int ret;

    xmlSecAssert2(fd != NULL, -1);

    ret = fclose(fd);
    if (ret != 0) {
        xmlSecInternalError("fclose", NULL);
        return(-1);
    }
    return(0);
}

/**
 * @brief Registers the default compiled-in I/O handlers.
 * @return 0 on success or a negative value otherwise.
 */
int
xmlSecIORegisterDefaultCallbacks(void) {
    int ret;

#ifndef XMLSEC_NO_FILES
    /* Callbacks added later are picked up first */
    ret = xmlSecIORegisterCallbacks(
        xmlSecIOFileMatch,
        xmlSecIOFileOpen,
        xmlSecIOFileRead,
        xmlSecIOFilClose
    );
    if(ret < 0) {
        xmlSecInternalError("xmlSecIORegisterCallbacks(file)", NULL);
        return(-1);
    }
#endif /* XMLSEC_NO_FILES */

#ifndef XMLSEC_NO_HTTP
    ret = xmlSecIORegisterCallbacks(xmlIOHTTPMatch, xmlIOHTTPOpen,
                              xmlIOHTTPRead, xmlIOHTTPClose);
    if(ret < 0) {
        xmlSecInternalError("xmlSecIORegisterCallbacks(http)", NULL);
        return(-1);
    }
#endif /* XMLSEC_NO_HTTP */

#ifndef XMLSEC_NO_FTP
    ret = xmlSecIORegisterCallbacks(xmlIOFTPMatch, xmlIOFTPOpen,
                              xmlIOFTPRead, xmlIOFTPClose);
    if(ret < 0) {
        xmlSecInternalError("xmlSecIORegisterCallbacks(ftp)", NULL);
        return(-1);
    }
#endif /* XMLSEC_NO_FTP */

    /* done */
    return(0);
}

/******************************************************************************
 *
 * Input URI Transform
 *
 * xmlSecTransform + xmlSecInputURICtx
 *
  *****************************************************************************/
typedef struct _xmlSecInputURICtx                               xmlSecInputURICtx,
                                                                *xmlSecInputURICtxPtr;
struct _xmlSecInputURICtx {
    xmlSecIOCallbackPtr         clbks;
    void*                       clbksCtx;
};

XMLSEC_TRANSFORM_DECLARE(InputUri, xmlSecInputURICtx)
#define xmlSecInputUriSize XMLSEC_TRANSFORM_SIZE(InputUri)

static int              xmlSecTransformInputURIInitialize       (xmlSecTransformPtr transform);
static void             xmlSecTransformInputURIFinalize         (xmlSecTransformPtr transform);
static int              xmlSecTransformInputURIPopBin           (xmlSecTransformPtr transform,
                                                                 xmlSecByte* data,
                                                                 xmlSecSize maxDataSize,
                                                                 xmlSecSize* dataSize,
                                                                 xmlSecTransformCtxPtr transformCtx);

static xmlSecTransformKlass xmlSecTransformInputURIKlass = {
    /* klass/object sizes */
    sizeof(xmlSecTransformKlass),               /* xmlSecSize klassSize */
    xmlSecInputUriSize,                         /* xmlSecSize objSize */

    BAD_CAST "input-uri",                       /* const xmlChar* name; */
    NULL,                                       /* const xmlChar* href; */
    0,                                          /* xmlSecAlgorithmUsage usage; */

    xmlSecTransformInputURIInitialize,          /* xmlSecTransformInitializeMethod initialize; */
    xmlSecTransformInputURIFinalize,            /* xmlSecTransformFinalizeMethod finalize; */
    NULL,                                       /* xmlSecTransformNodeReadMethod readNode; */
    NULL,                                       /* xmlSecTransformNodeWriteMethod writeNode; */
    NULL,                                       /* xmlSecTransformSetKeyReqMethod setKeyReq; */
    NULL,                                       /* xmlSecTransformSetKeyMethod setKey; */
    NULL,                                       /* xmlSecTransformValidateMethod validate; */
    xmlSecTransformDefaultGetDataType,          /* xmlSecTransformGetDataTypeMethod getDataType; */
    NULL,                                       /* xmlSecTransformPushBinMethod pushBin; */
    xmlSecTransformInputURIPopBin,              /* xmlSecTransformPopBinMethod popBin; */
    NULL,                                       /* xmlSecTransformPushXmlMethod pushXml; */
    NULL,                                       /* xmlSecTransformPopXmlMethod popXml; */
    NULL,                                       /* xmlSecTransformExecuteMethod execute; */

    NULL,                                       /* void* reserved0; */
    NULL,                                       /* void* reserved1; */
};

/**
 * @brief Gets the input URI transform klass.
 * @details The input uri transform klass. Reads binary data from an uri.
 * @return input URI transform id.
 */
xmlSecTransformId
xmlSecTransformInputURIGetKlass(void) {
    return(&xmlSecTransformInputURIKlass);
}

/**
 * @brief Opens the given @p uri for reading.
 * @param transform the pointer to IO transform.
 * @param uri the URL to open.
 * @return 0 on success or a negative value otherwise.
 */
int
xmlSecTransformInputURIOpen(xmlSecTransformPtr transform, const xmlChar *uri) {
    xmlSecInputURICtxPtr ctx;

    xmlSecAssert2(xmlSecTransformCheckId(transform, xmlSecTransformInputURIId), -1);
    xmlSecAssert2(uri != NULL, -1);

    ctx = xmlSecInputUriGetCtx(transform);
    xmlSecAssert2(ctx != NULL, -1);
    xmlSecAssert2(ctx->clbks == NULL, -1);
    xmlSecAssert2(ctx->clbksCtx == NULL, -1);

    /*
     * Try to find one of the input accept method accepting that scheme
     * Go in reverse to give precedence to user defined handlers.
     * try with an unescaped version of the uri
     */
    if(ctx->clbks == NULL) {
        char *unescaped;

        unescaped = xmlURIUnescapeString((char*)uri, 0, NULL);
        if (unescaped != NULL) {
            ctx->clbks = xmlSecIOCallbackPtrListFind(&xmlSecAllIOCallbacks, unescaped);
            if(ctx->clbks != NULL) {
                ctx->clbksCtx = ctx->clbks->opencallback(unescaped);
            }
            xmlFree(unescaped);
        }
    }

    /*
     * If this failed try with a non-escaped uri this may be a strange
     * filename
     */
    if (ctx->clbks == NULL) {
        ctx->clbks = xmlSecIOCallbackPtrListFind(&xmlSecAllIOCallbacks, (char*)uri);
        if(ctx->clbks != NULL) {
            ctx->clbksCtx = ctx->clbks->opencallback((char*)uri);
        }
    }

    if((ctx->clbks == NULL) || (ctx->clbksCtx == NULL)) {
        xmlSecInternalError2("ctx->clbks->opencallback", xmlSecTransformGetName(transform),
                            "uri=%s", xmlSecErrorsSafeString(uri));
        return(-1);
    }

    return(0);
}


/**
 * @brief Closes the given @p transform.
 * @details Closes the given @p transform and frees up resources.
 * @param transform the pointer to IO transform.
 * @return 0 on success or a negative value otherwise.
 */
int
xmlSecTransformInputURIClose(xmlSecTransformPtr transform) {
    xmlSecInputURICtxPtr ctx;

    xmlSecAssert2(xmlSecTransformCheckId(transform, xmlSecTransformInputURIId), -1);

    ctx = xmlSecInputUriGetCtx(transform);
    xmlSecAssert2(ctx != NULL, -1);

    /* close if still open and mark as closed */
    if((ctx->clbksCtx != NULL) && (ctx->clbks != NULL) && (ctx->clbks->closecallback != NULL)) {
        (ctx->clbks->closecallback)(ctx->clbksCtx);
        ctx->clbksCtx = NULL;
        ctx->clbks = NULL;
    }

    /* done */
    return(0);
}

static int
xmlSecTransformInputURIInitialize(xmlSecTransformPtr transform) {
    xmlSecInputURICtxPtr ctx;

    xmlSecAssert2(xmlSecTransformCheckId(transform, xmlSecTransformInputURIId), -1);

    ctx = xmlSecInputUriGetCtx(transform);
    xmlSecAssert2(ctx != NULL, -1);

    memset(ctx, 0, sizeof(xmlSecInputURICtx));
    return(0);
}

static void
xmlSecTransformInputURIFinalize(xmlSecTransformPtr transform) {
    xmlSecInputURICtxPtr ctx;
    int ret;

    xmlSecAssert(xmlSecTransformCheckId(transform, xmlSecTransformInputURIId));

    ctx = xmlSecInputUriGetCtx(transform);
    xmlSecAssert(ctx != NULL);

    ret = xmlSecTransformInputURIClose(transform);
    if(ret < 0) {
        xmlSecInternalError2("xmlSecTransformInputURIClose",
                             xmlSecTransformGetName(transform),
                             "ret=%d", ret);
        /* ignore the error */
        /* return; */
    }

    memset(ctx, 0, sizeof(xmlSecInputURICtx));
    return;
}

static int
xmlSecTransformInputURIPopBin(xmlSecTransformPtr transform, xmlSecByte* data,
                              xmlSecSize maxDataSize, xmlSecSize* dataSize,
                              xmlSecTransformCtxPtr transformCtx) {
    xmlSecInputURICtxPtr ctx;
    int maxDataLen;
    int ret;

    xmlSecAssert2(xmlSecTransformCheckId(transform, xmlSecTransformInputURIId), -1);
    xmlSecAssert2(data != NULL, -1);
    xmlSecAssert2(dataSize != NULL, -1);
    xmlSecAssert2(transformCtx != NULL, -1);

    ctx = xmlSecInputUriGetCtx(transform);
    xmlSecAssert2(ctx != NULL, -1);

    if((ctx->clbksCtx != NULL) && (ctx->clbks != NULL) && (ctx->clbks->readcallback != NULL)) {
        XMLSEC_SAFE_CAST_SIZE_TO_INT(maxDataSize, maxDataLen, return(-1), xmlSecTransformGetName(transform));
        ret = (ctx->clbks->readcallback)(ctx->clbksCtx, (char*)data, maxDataLen);
        if(ret < 0) {
            xmlSecInternalError("ctx->clbks->readcallback", xmlSecTransformGetName(transform));
            return(-1);
        }
        XMLSEC_SAFE_CAST_INT_TO_SIZE(ret, (*dataSize), return(-1), NULL);
    } else {
        (*dataSize) = 0;
    }
    return(0);
}