Skip to content

[3.6] bpo-13617: Reject embedded null characters in wchar* strings. (GH-2302) #2462

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

Merged
merged 2 commits into from
Jun 28, 2017
Merged
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
10 changes: 7 additions & 3 deletions Include/unicodeobject.h
Original file line number Diff line number Diff line change
Expand Up @@ -752,23 +752,27 @@ PyAPI_FUNC(Py_UCS4*) PyUnicode_AsUCS4(
PyAPI_FUNC(Py_UCS4*) PyUnicode_AsUCS4Copy(PyObject *unicode);
#endif

#ifndef Py_LIMITED_API
/* Return a read-only pointer to the Unicode object's internal
Py_UNICODE buffer.
If the wchar_t/Py_UNICODE representation is not yet available, this
function will calculate it. */

#ifndef Py_LIMITED_API
PyAPI_FUNC(Py_UNICODE *) PyUnicode_AsUnicode(
PyObject *unicode /* Unicode object */
);
#endif

/* Similar to PyUnicode_AsUnicode(), but raises a ValueError if the string
contains null characters. */
PyAPI_FUNC(const Py_UNICODE *) _PyUnicode_AsUnicode(
PyObject *unicode /* Unicode object */
);

/* Return a read-only pointer to the Unicode object's internal
Py_UNICODE buffer and save the length at size.
If the wchar_t/Py_UNICODE representation is not yet available, this
function will calculate it. */

#ifndef Py_LIMITED_API
PyAPI_FUNC(Py_UNICODE *) PyUnicode_AsUnicodeAndSize(
PyObject *unicode, /* Unicode object */
Py_ssize_t *size /* location where to save the length */
Expand Down
2 changes: 2 additions & 0 deletions Lib/ctypes/test/test_loading.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ def test_load_library(self):
windll["kernel32"].GetModuleHandleW
windll.LoadLibrary("kernel32").GetModuleHandleW
WinDLL("kernel32").GetModuleHandleW
# embedded null character
self.assertRaises(ValueError, windll.LoadLibrary, "kernel32\0")

@unittest.skipUnless(os.name == "nt",
'test specific to Windows')
Expand Down
6 changes: 6 additions & 0 deletions Lib/test/test_builtin.py
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,8 @@ def test_import(self):
self.assertRaises(TypeError, __import__, 1, 2, 3, 4)
self.assertRaises(ValueError, __import__, '')
self.assertRaises(TypeError, __import__, 'sys', name='sys')
# embedded null character
self.assertRaises(ModuleNotFoundError, __import__, 'string\x00')

def test_abs(self):
# int
Expand Down Expand Up @@ -1002,6 +1004,10 @@ def test_open(self):
self.assertEqual(fp.read(300), 'XXX'*100)
self.assertEqual(fp.read(1000), 'YYY'*100)

# embedded null bytes and characters
self.assertRaises(ValueError, open, 'a\x00b')
self.assertRaises(ValueError, open, b'a\x00b')

def test_open_default_encoding(self):
old_environ = dict(os.environ)
try:
Expand Down
11 changes: 10 additions & 1 deletion Lib/test/test_curses.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ def test_window_funcs(self):
win2 = curses.newwin(15,15, 5,5)

for meth in [stdscr.addch, stdscr.addstr]:
for args in [('a'), ('a', curses.A_BOLD),
for args in [('a',), ('a', curses.A_BOLD),
(4,4, 'a'), (5,5, 'a', curses.A_BOLD)]:
with self.subTest(meth=meth.__qualname__, args=args):
meth(*args)
Expand Down Expand Up @@ -194,6 +194,15 @@ def test_window_funcs(self):
self.assertRaises(ValueError, stdscr.instr, -2)
self.assertRaises(ValueError, stdscr.instr, 2, 3, -2)

def test_embedded_null_chars(self):
# reject embedded null bytes and characters
stdscr = self.stdscr
for arg in ['a', b'a']:
with self.subTest(arg=arg):
self.assertRaises(ValueError, stdscr.addstr, 'a\0')
self.assertRaises(ValueError, stdscr.addnstr, 'a\0', 1)
self.assertRaises(ValueError, stdscr.insstr, 'a\0')
self.assertRaises(ValueError, stdscr.insnstr, 'a\0', 1)

def test_module_funcs(self):
"Test module-level functions"
Expand Down
2 changes: 2 additions & 0 deletions Lib/test/test_grp.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ def test_errors(self):
self.assertRaises(TypeError, grp.getgrgid)
self.assertRaises(TypeError, grp.getgrnam)
self.assertRaises(TypeError, grp.getgrall, 42)
# embedded null character
self.assertRaises(ValueError, grp.getgrnam, 'a\x00b')

# try to get some errors
bynames = {}
Expand Down
4 changes: 4 additions & 0 deletions Lib/test/test_imp.py
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,10 @@ def test_multiple_calls_to_get_data(self):
loader.get_data(imp.__file__) # File should be closed
loader.get_data(imp.__file__) # Will need to create a newly opened file

def test_load_source(self):
with self.assertRaisesRegex(ValueError, 'embedded null'):
imp.load_source(__name__, __file__ + "\0")


class ReloadTests(unittest.TestCase):

Expand Down
5 changes: 5 additions & 0 deletions Lib/test/test_locale.py
Original file line number Diff line number Diff line change
Expand Up @@ -339,9 +339,14 @@ def test_strcoll(self):
self.assertLess(locale.strcoll('a', 'b'), 0)
self.assertEqual(locale.strcoll('a', 'a'), 0)
self.assertGreater(locale.strcoll('b', 'a'), 0)
# embedded null character
self.assertRaises(ValueError, locale.strcoll, 'a\0', 'a')
self.assertRaises(ValueError, locale.strcoll, 'a', 'a\0')

def test_strxfrm(self):
self.assertLess(locale.strxfrm('a'), locale.strxfrm('b'))
# embedded null character
self.assertRaises(ValueError, locale.strxfrm, 'a\0')


class TestEnUSCollation(BaseLocalizedTest, TestCollation):
Expand Down
4 changes: 4 additions & 0 deletions Lib/test/test_time.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,10 @@ def test_strftime(self):
except ValueError:
self.fail('conversion specifier: %r failed.' % format)

self.assertRaises(TypeError, time.strftime, b'%S', tt)
# embedded null character
self.assertRaises(ValueError, time.strftime, '%S\0', tt)

def _bounds_checking(self, func):
# Make sure that strftime() checks the bounds of the various parts
# of the time tuple (0 is valid for *all* values).
Expand Down
2 changes: 2 additions & 0 deletions Lib/test/test_winsound.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@ def test_errors(self):
self.assertRaises(TypeError, winsound.PlaySound, "bad",
winsound.SND_MEMORY)
self.assertRaises(TypeError, winsound.PlaySound, 1, 0)
# embedded null character
self.assertRaises(ValueError, winsound.PlaySound, 'bad\0', 0)

def test_keyword_args(self):
safe_PlaySound(flags=winsound.SND_ALIAS, sound="SystemExit")
Expand Down
7 changes: 4 additions & 3 deletions Modules/_ctypes/callproc.c
Original file line number Diff line number Diff line change
Expand Up @@ -1231,14 +1231,15 @@ The handle may be used to locate exported functions in this\n\
module.\n";
static PyObject *load_library(PyObject *self, PyObject *args)
{
WCHAR *name;
const WCHAR *name;
PyObject *nameobj;
PyObject *ignored;
HMODULE hMod;
if (!PyArg_ParseTuple(args, "O|O:LoadLibrary", &nameobj, &ignored))

if (!PyArg_ParseTuple(args, "U|O:LoadLibrary", &nameobj, &ignored))
return NULL;

name = PyUnicode_AsUnicode(nameobj);
name = _PyUnicode_AsUnicode(nameobj);
if (!name)
return NULL;

Expand Down
9 changes: 9 additions & 0 deletions Modules/_cursesmodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,7 @@ static int
PyCurses_ConvertToString(PyCursesWindowObject *win, PyObject *obj,
PyObject **bytes, wchar_t **wstr)
{
char *str;
if (PyUnicode_Check(obj)) {
#ifdef HAVE_NCURSESW
assert (wstr != NULL);
Expand All @@ -354,12 +355,20 @@ PyCurses_ConvertToString(PyCursesWindowObject *win, PyObject *obj,
*bytes = PyUnicode_AsEncodedString(obj, win->encoding, NULL);
if (*bytes == NULL)
return 0;
/* check for embedded null bytes */
if (PyBytes_AsStringAndSize(*bytes, &str, NULL) < 0) {
return 0;
}
return 1;
#endif
}
else if (PyBytes_Check(obj)) {
Py_INCREF(obj);
*bytes = obj;
/* check for embedded null bytes */
if (PyBytes_AsStringAndSize(*bytes, &str, NULL) < 0) {
return 0;
}
return 1;
}

Expand Down
3 changes: 1 addition & 2 deletions Modules/_io/fileio.c
Original file line number Diff line number Diff line change
Expand Up @@ -280,11 +280,10 @@ _io_FileIO___init___impl(fileio *self, PyObject *nameobj, const char *mode,

if (fd < 0) {
#ifdef MS_WINDOWS
Py_ssize_t length;
if (!PyUnicode_FSDecoder(nameobj, &stringobj)) {
return -1;
}
widename = PyUnicode_AsUnicodeAndSize(stringobj, &length);
widename = PyUnicode_AsUnicode(stringobj);
if (widename == NULL)
return -1;
#else
Expand Down
5 changes: 5 additions & 0 deletions Modules/_localemodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,11 @@ PyLocale_strxfrm(PyObject* self, PyObject* args)
s = PyUnicode_AsWideCharString(str, &n1);
if (s == NULL)
goto exit;
if (wcslen(s) != (size_t)n1) {
PyErr_SetString(PyExc_ValueError,
"embedded null character");
goto exit;
}

/* assume no change in size, first */
n1 = n1 + 1;
Expand Down
1 change: 1 addition & 0 deletions Modules/grpmodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,7 @@ grp_getgrnam_impl(PyObject *module, PyObject *name)

if ((bytes = PyUnicode_EncodeFSDefault(name)) == NULL)
return NULL;
/* check for embedded null bytes */
if (PyBytes_AsStringAndSize(bytes, &name_chars, NULL) == -1)
goto out;

Expand Down
1 change: 1 addition & 0 deletions Modules/nismodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@ nis_match (PyObject *self, PyObject *args, PyObject *kwdict)
return NULL;
if ((bkey = PyUnicode_EncodeFSDefault(ukey)) == NULL)
return NULL;
/* check for embedded null bytes */
if (PyBytes_AsStringAndSize(bkey, &key, &keylen) == -1) {
Py_DECREF(bkey);
return NULL;
Expand Down
18 changes: 12 additions & 6 deletions Modules/posixmodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -3680,7 +3680,7 @@ os__getfinalpathname_impl(PyObject *module, PyObject *path)
PyObject *result;
const wchar_t *path_wchar;

path_wchar = PyUnicode_AsUnicode(path);
path_wchar = _PyUnicode_AsUnicode(path);
if (path_wchar == NULL)
return NULL;

Expand Down Expand Up @@ -7088,7 +7088,7 @@ win_readlink(PyObject *self, PyObject *args, PyObject *kwargs)
))
return NULL;

path = PyUnicode_AsUnicode(po);
path = _PyUnicode_AsUnicode(po);
if (path == NULL)
return NULL;

Expand Down Expand Up @@ -8881,6 +8881,7 @@ os_putenv_impl(PyObject *module, PyObject *name, PyObject *value)
/*[clinic end generated code: output=d29a567d6b2327d2 input=ba586581c2e6105f]*/
{
const wchar_t *env;
Py_ssize_t size;

/* Search from index 1 because on Windows starting '=' is allowed for
defining hidden environment variables. */
Expand All @@ -8894,16 +8895,21 @@ os_putenv_impl(PyObject *module, PyObject *name, PyObject *value)
if (unicode == NULL) {
return NULL;
}
if (_MAX_ENV < PyUnicode_GET_LENGTH(unicode)) {

env = PyUnicode_AsUnicodeAndSize(unicode, &size);
if (env == NULL)
goto error;
if (size > _MAX_ENV) {
PyErr_Format(PyExc_ValueError,
"the environment variable is longer than %u characters",
_MAX_ENV);
goto error;
}

env = PyUnicode_AsUnicode(unicode);
if (env == NULL)
if (wcslen(env) != (size_t)size) {
PyErr_SetString(PyExc_ValueError, "embedded null character");
goto error;
}

if (_wputenv(env)) {
posix_error();
goto error;
Expand Down
1 change: 1 addition & 0 deletions Modules/pwdmodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@ pwd_getpwnam_impl(PyObject *module, PyObject *arg)

if ((bytes = PyUnicode_EncodeFSDefault(arg)) == NULL)
return NULL;
/* check for embedded null bytes */
if (PyBytes_AsStringAndSize(bytes, &name, NULL) == -1)
goto out;
if ((p = getpwnam(name)) == NULL) {
Expand Down
1 change: 1 addition & 0 deletions Modules/spwdmodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ spwd_getspnam_impl(PyObject *module, PyObject *arg)

if ((bytes = PyUnicode_EncodeFSDefault(arg)) == NULL)
return NULL;
/* check for embedded null bytes */
if (PyBytes_AsStringAndSize(bytes, &name, NULL) == -1)
goto out;
if ((p = getspnam(name)) == NULL) {
Expand Down
14 changes: 14 additions & 0 deletions Objects/unicodeobject.c
Original file line number Diff line number Diff line change
Expand Up @@ -4164,6 +4164,20 @@ PyUnicode_AsUnicode(PyObject *unicode)
return PyUnicode_AsUnicodeAndSize(unicode, NULL);
}

const Py_UNICODE *
_PyUnicode_AsUnicode(PyObject *unicode)
{
Py_ssize_t size;
const Py_UNICODE *wstr;

wstr = PyUnicode_AsUnicodeAndSize(unicode, &size);
if (wstr && wcslen(wstr) != (size_t)size) {
PyErr_SetString(PyExc_ValueError, "embedded null character");
return NULL;
}
return wstr;
}


Py_ssize_t
PyUnicode_GetSize(PyObject *unicode)
Expand Down
6 changes: 5 additions & 1 deletion PC/_msi.c
Original file line number Diff line number Diff line change
Expand Up @@ -600,8 +600,12 @@ summary_setproperty(msiobj* si, PyObject *args)
return NULL;

if (PyUnicode_Check(data)) {
const WCHAR *value = _PyUnicode_AsUnicode(data);
if (value == NULL) {
return NULL;
}
status = MsiSummaryInfoSetPropertyW(si->h, field, VT_LPSTR,
0, NULL, PyUnicode_AsUnicode(data));
0, NULL, value);
} else if (PyLong_CheckExact(data)) {
long value = PyLong_AsLong(data);
if (value == -1 && PyErr_Occurred()) {
Expand Down
4 changes: 2 additions & 2 deletions Python/dynload_win.c
Original file line number Diff line number Diff line change
Expand Up @@ -190,13 +190,13 @@ dl_funcptr _PyImport_FindSharedFuncptrWindows(const char *prefix,
{
dl_funcptr p;
char funcname[258], *import_python;
wchar_t *wpathname;
const wchar_t *wpathname;

#ifndef _DEBUG
_Py_CheckPython3();
#endif

wpathname = PyUnicode_AsUnicode(pathname);
wpathname = _PyUnicode_AsUnicode(pathname);
if (wpathname == NULL)
return NULL;

Expand Down
Loading