Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

wip: use xmlsec's noxxe entity loader #2654

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions LICENSE-DEPENDENCIES.md
Original file line number Diff line number Diff line change
Expand Up @@ -412,6 +412,36 @@ http://xmlsoft.org/libxslt/
----------------------------------------------------------------------


### xmlsec

MIT

https://www.aleksey.com/xmlsec/

Copyright (C) 2002-2016 Aleksey Sanin <aleksey@aleksey.com>. All Rights Reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is fur-
nished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FIT-
NESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
ALEKSEY SANIN BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CON-
NECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of Aleksey Sanin shall not
be used in advertising or otherwise to promote the sale, use or other deal-
ings in this Software without prior written authorization from him.


### zlib

zlib license
Expand Down
1 change: 1 addition & 0 deletions ext/nokogiri/html4_sax_parser_context.c
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ parse_with(VALUE self, VALUE sax_handler)
ctxt->userData = (void *)NOKOGIRI_SAX_TUPLE_NEW(ctxt, sax_handler);

xmlSetStructuredErrorFunc(NULL, NULL);
noko_xmlsec_reset_entity_loader();

rb_ensure(parse_doc, (VALUE)ctxt, parse_doc_finalize, (VALUE)ctxt);

Expand Down
2 changes: 2 additions & 0 deletions ext/nokogiri/nokogiri.c
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ void noko_init_html_entity_lookup(void);
void noko_init_html_sax_parser_context(void);
void noko_init_html_sax_push_parser(void);
void noko_init_gumbo(void);
void noko_init_xmlsec(void);
void noko_init_test_global_handlers(void);

static ID id_read, id_write, id_external_encoding;
Expand Down Expand Up @@ -250,6 +251,7 @@ Init_nokogiri()
noko_init_xml_document();
noko_init_html_document();
noko_init_gumbo();
noko_init_xmlsec();

noko_init_test_global_handlers();

Expand Down
3 changes: 3 additions & 0 deletions ext/nokogiri/nokogiri.h
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,9 @@ NORETURN_DECL void Nokogiri_error_raise(void *ctx, xmlErrorPtr error);
void Nokogiri_marshal_xpath_funcall_and_return_values(xmlXPathParserContextPtr ctx, int nargs, VALUE handler,
const char *function_name) ;

xmlParserInputPtr Nokogiri_xmlSecNoXxeExternalEntityLoader(const char *URL, const char *ID, xmlParserCtxtPtr ctxt);
void noko_xmlsec_reset_entity_loader(void);

static inline
nokogiriSAXTuplePtr
nokogiri_sax_tuple_new(xmlParserCtxtPtr ctxt, VALUE self)
Expand Down
29 changes: 27 additions & 2 deletions ext/nokogiri/xml_document.c
Original file line number Diff line number Diff line change
Expand Up @@ -271,18 +271,30 @@ read_io(VALUE klass,
VALUE error_list = rb_ary_new();
VALUE document;
xmlDocPtr doc;
int parse_options_int = (int)NUM2INT(rb_funcall(options, rb_intern("to_i"), 0));
xmlExternalEntityLoader old_loader = 0;

xmlResetLastError();
xmlSetStructuredErrorFunc((void *)error_list, Nokogiri_error_array_pusher);

if (parse_options_int & XML_PARSE_NONET) {
old_loader = xmlGetExternalEntityLoader();
xmlSetExternalEntityLoader(Nokogiri_xmlSecNoXxeExternalEntityLoader);
}

doc = xmlReadIO(
(xmlInputReadCallback)noko_io_read,
(xmlInputCloseCallback)noko_io_close,
(void *)io,
c_url,
c_enc,
(int)NUM2INT(options)
parse_options_int
);

if (old_loader) {
xmlSetExternalEntityLoader(old_loader);
}

xmlSetStructuredErrorFunc(NULL, NULL);

if (doc == NULL) {
Expand Down Expand Up @@ -325,10 +337,23 @@ read_memory(VALUE klass,
VALUE error_list = rb_ary_new();
VALUE document;
xmlDocPtr doc;
int parse_options_int = (int)NUM2INT(rb_funcall(options, rb_intern("to_i"), 0));
xmlExternalEntityLoader old_loader = 0;

xmlResetLastError();
xmlSetStructuredErrorFunc((void *)error_list, Nokogiri_error_array_pusher);
doc = xmlReadMemory(c_buffer, len, c_url, c_enc, (int)NUM2INT(options));

if (parse_options_int & XML_PARSE_NONET) {
old_loader = xmlGetExternalEntityLoader();
xmlSetExternalEntityLoader(Nokogiri_xmlSecNoXxeExternalEntityLoader);
}

doc = xmlReadMemory(c_buffer, len, c_url, c_enc, parse_options_int);

if (old_loader) {
xmlSetExternalEntityLoader(old_loader);
}

xmlSetStructuredErrorFunc(NULL, NULL);

if (doc == NULL) {
Expand Down
69 changes: 69 additions & 0 deletions ext/nokogiri/xmlsec.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
#include <nokogiri.h>

/*
* This file contains code originally written as part of the xmlsec library.
*
* https://www.aleksey.com/xmlsec/
*
* Copyright (C) 2002-2022 Aleksey Sanin <aleksey@aleksey.com>. All Rights Reserved.
*/

/* --- taken from include/xmlsec/errors.h --- */
/**
* xmlSecErrorsSafeString:
* @str: the string.
*
* Macro. Returns @str if it is not NULL or pointer to "NULL" otherwise.
*/
#define xmlSecErrorsSafeString(str) \
(((str) != NULL) ? ((const char*)(str)) : (const char*)"NULL")


/* --- taken from src/xmlsec.c --- */
/*
* Custom external entity handler, denies all files except the initial
* document we're parsing (input_id == 1)
*/
/* default external entity loader, pointer saved during xmlInit */
static xmlExternalEntityLoader
xmlSecDefaultExternalEntityLoader = NULL;

/*
* xmlSecNoXxeExternalEntityLoader:
* @URL: the URL for the entity to load
* @ID: public ID for the entity to load
* @ctxt: XML parser context, or NULL
*
* See libxml2's xmlLoadExternalEntity and xmlNoNetExternalEntityLoader.
* This function prevents any external (file or network) entities from being loaded.
*/
xmlParserInputPtr
Nokogiri_xmlSecNoXxeExternalEntityLoader(
const char *URL,
const char *ID,
xmlParserCtxtPtr ctxt
)
{
if (ctxt == NULL) {
return (NULL);
}
if (ctxt->input_id == 1) {
return xmlSecDefaultExternalEntityLoader((const char *) URL, ID, ctxt);
}
xmlParserError(ctxt, "NONET disallows external entity '%s'\n", xmlSecErrorsSafeString(URL));
return (NULL);
}


void noko_xmlsec_reset_entity_loader(void)
{
xmlSetExternalEntityLoader(xmlSecDefaultExternalEntityLoader);
}

void
noko_init_xmlsec()
{
if (!xmlSecDefaultExternalEntityLoader) {
xmlSecDefaultExternalEntityLoader = xmlGetExternalEntityLoader();
}
}