plugins/python: add sudo debug helpers
This commit is contained in:
Robert Manner
committed by
Todd C. Miller
Todd C. Miller
parent
c0d53d75eb
commit
311cf122e2
149
plugins/python/sudo_python_debug.c
Normal file
149
plugins/python/sudo_python_debug.c
Normal file
@@ -0,0 +1,149 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: ISC
|
||||
*
|
||||
* Copyright (c) 2019 Todd C. Miller <Todd.Miller@sudo.ws>
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
/*
|
||||
* This is an open source non-commercial project. Dear PVS-Studio, please check it.
|
||||
* PVS-Studio Static Code Analyzer for C, C++ and C#: http://www.viva64.com
|
||||
*/
|
||||
|
||||
#include <config.h>
|
||||
|
||||
#ifdef HAVE_STRING_H
|
||||
# include <string.h>
|
||||
#endif
|
||||
|
||||
#include <ctype.h>
|
||||
#include <stdlib.h>
|
||||
|
||||
#include "sudo_gettext.h"
|
||||
#include "sudo_compat.h"
|
||||
#include "sudo_python_debug.h"
|
||||
#include "sudo_queue.h"
|
||||
#include "sudo_conf.h"
|
||||
#include "sudo_fatal.h"
|
||||
|
||||
|
||||
static int python_debug_instance = SUDO_DEBUG_INSTANCE_INITIALIZER;
|
||||
|
||||
static const char *const python_subsystem_names[] = {
|
||||
"py_calls", // logs c -> py calls
|
||||
"c_calls", // logs py -> c calls
|
||||
"load", // logs python plugin loading / unloading
|
||||
"sudo_cb", // logs sudo callback calls
|
||||
"internal", // logs internal functions of the language wrapper plugin
|
||||
"plugin", // logs whatever log the python module would like to log through sudo.debug API
|
||||
NULL
|
||||
};
|
||||
|
||||
#define NUM_SUBSYSTEMS sizeof(python_subsystem_names) / sizeof(*python_subsystem_names) - 1
|
||||
|
||||
/* Subsystem IDs assigned at registration time. */
|
||||
int python_subsystem_ids[NUM_SUBSYSTEMS];
|
||||
|
||||
/*
|
||||
* Parse the "filename flags,..." debug_flags entry and insert a new
|
||||
* sudo_debug_file struct into debug_files.
|
||||
*/
|
||||
bool
|
||||
python_debug_parse_flags(struct sudo_conf_debug_file_list *debug_files,
|
||||
const char *entry)
|
||||
{
|
||||
struct sudo_debug_file *debug_file;
|
||||
const char *filename, *flags;
|
||||
size_t namelen;
|
||||
|
||||
/* Already initialized? */
|
||||
if (python_debug_instance != SUDO_DEBUG_INSTANCE_INITIALIZER)
|
||||
return true;
|
||||
|
||||
/* Only process new-style debug flags: filename flags,... */
|
||||
filename = entry;
|
||||
if (*filename != '/' || (flags = strpbrk(filename, " \t")) == NULL)
|
||||
return true;
|
||||
namelen = (size_t)(flags - filename);
|
||||
while (isblank((unsigned char)*flags))
|
||||
flags++;
|
||||
if (*flags != '\0') {
|
||||
if ((debug_file = calloc(1, sizeof(*debug_file))) == NULL)
|
||||
goto oom;
|
||||
if ((debug_file->debug_file = strndup(filename, namelen)) == NULL)
|
||||
goto oom;
|
||||
if ((debug_file->debug_flags = strdup(flags)) == NULL)
|
||||
goto oom;
|
||||
TAILQ_INSERT_TAIL(debug_files, debug_file, entries);
|
||||
}
|
||||
return true;
|
||||
oom:
|
||||
if (debug_file != NULL) {
|
||||
free(debug_file->debug_file);
|
||||
free(debug_file->debug_flags);
|
||||
free(debug_file);
|
||||
}
|
||||
sudo_warnx_nodebug(U_("%s: %s"), "python_debug_parse_flags",
|
||||
U_("unable to allocate memory"));
|
||||
return false;
|
||||
}
|
||||
|
||||
/*
|
||||
* Register the specified debug files and program with the
|
||||
* debug subsystem, freeing the debug list when done.
|
||||
* Sets the active debug instance as a side effect.
|
||||
*/
|
||||
bool
|
||||
python_debug_register(const char *program,
|
||||
struct sudo_conf_debug_file_list *debug_files)
|
||||
{
|
||||
struct sudo_debug_file *debug_file, *debug_next;
|
||||
|
||||
/* Already initialized? */
|
||||
if (python_debug_instance != SUDO_DEBUG_INSTANCE_INITIALIZER) {
|
||||
sudo_debug_set_active_instance(python_debug_instance);
|
||||
}
|
||||
|
||||
/* Setup debugging if indicated. */
|
||||
if (debug_files != NULL && !TAILQ_EMPTY(debug_files)) {
|
||||
if (program != NULL) {
|
||||
python_debug_instance = sudo_debug_register(program,
|
||||
python_subsystem_names, (unsigned int *)python_subsystem_ids, debug_files);
|
||||
if (python_debug_instance == SUDO_DEBUG_INSTANCE_ERROR)
|
||||
return false;
|
||||
}
|
||||
TAILQ_FOREACH_SAFE(debug_file, debug_files, entries, debug_next) {
|
||||
TAILQ_REMOVE(debug_files, debug_file, entries);
|
||||
free(debug_file->debug_file);
|
||||
free(debug_file->debug_flags);
|
||||
free(debug_file);
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/*
|
||||
* Deregister python_debug_instance if it is registered.
|
||||
*/
|
||||
void
|
||||
python_debug_deregister(void)
|
||||
{
|
||||
debug_decl(python_debug_deregister, PYTHON_DEBUG_INTERNAL)
|
||||
|
||||
if (python_debug_instance != SUDO_DEBUG_INSTANCE_INITIALIZER) {
|
||||
sudo_debug_exit(__func__, __FILE__, __LINE__, sudo_debug_subsys);
|
||||
sudo_debug_deregister(python_debug_instance);
|
||||
python_debug_instance = SUDO_DEBUG_INSTANCE_INITIALIZER;
|
||||
}
|
||||
}
|
||||
46
plugins/python/sudo_python_debug.h
Normal file
46
plugins/python/sudo_python_debug.h
Normal file
@@ -0,0 +1,46 @@
|
||||
/*
|
||||
* SPDX-License-Identifier: ISC
|
||||
*
|
||||
* Copyright (c) 2014 Todd C. Miller <Todd.Miller@sudo.ws>
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef SUDO_PYTHON_DEBUG_H
|
||||
#define SUDO_PYTHON_DEBUG_H
|
||||
|
||||
#include "sudo_debug.h"
|
||||
|
||||
/*
|
||||
* Sudo python plugin debug subsystems.
|
||||
* Note that python_subsystem_ids[] is filled in at debug registration time.
|
||||
*/
|
||||
extern int python_subsystem_ids[];
|
||||
#define PYTHON_DEBUG_PY_CALLS (python_subsystem_ids[0])
|
||||
#define PYTHON_DEBUG_C_CALLS (python_subsystem_ids[1])
|
||||
#define PYTHON_DEBUG_PLUGIN_LOAD (python_subsystem_ids[2])
|
||||
#define PYTHON_DEBUG_CALLBACKS (python_subsystem_ids[3])
|
||||
#define PYTHON_DEBUG_INTERNAL (python_subsystem_ids[4])
|
||||
#define PYTHON_DEBUG_PLUGIN (python_subsystem_ids[5])
|
||||
|
||||
bool python_debug_parse_flags(struct sudo_conf_debug_file_list *debug_files, const char *entry);
|
||||
bool python_debug_register(const char *program, struct sudo_conf_debug_file_list *debug_files);
|
||||
void python_debug_deregister(void);
|
||||
|
||||
#define debug_return_ptr_pynone \
|
||||
do { \
|
||||
Py_INCREF(Py_None); \
|
||||
debug_return_ptr(Py_None); \
|
||||
} while(0)
|
||||
|
||||
#endif /* SUDO_PYTHON_DEBUG_H */
|
||||
Reference in New Issue
Block a user