mirror of
https://github.com/warmcat/libwebsockets.git
synced 2025-03-23 00:00:06 +01:00

This has no effect on user code or backward compatibility. It moves the in-tree public api header libwebsockets.h from ./lib to ./include, and introduces a dir ./include/libwebsockets/ The single public api header is split out into 31 sub-headers in ./include/libwebsockets. ./include/libwebsockets.h contains some core types and platform adaptation code, but the rest of it is now 31 #include <libwebsockets/...> At install time, /usr/[local/]include/libwebsockets.h is installed as before, along now with the 31 sub-headers in ...include/libwebsockets/ There's no net effect on user code. But the api header is now much easier to maintain and study, with 31 topic-based sub headers.
81 lines
2.5 KiB
C
81 lines
2.5 KiB
C
/*
|
|
* libwebsockets - small server side websockets and web server implementation
|
|
*
|
|
* Copyright (C) 2010-2018 Andy Green <andy@warmcat.com>
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation:
|
|
* version 2.1 of the License.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
|
* MA 02110-1301 USA
|
|
*
|
|
* included from libwebsockets.h
|
|
*/
|
|
|
|
|
|
/*! \defgroup pur Sanitize / purify SQL and JSON helpers
|
|
*
|
|
* ##Sanitize / purify SQL and JSON helpers
|
|
*
|
|
* APIs for escaping untrusted JSON and SQL safely before use
|
|
*/
|
|
//@{
|
|
|
|
/**
|
|
* lws_sql_purify() - like strncpy but with escaping for sql quotes
|
|
*
|
|
* \param escaped: output buffer
|
|
* \param string: input buffer ('/0' terminated)
|
|
* \param len: output buffer max length
|
|
*
|
|
* Because escaping expands the output string, it's not
|
|
* possible to do it in-place, ie, with escaped == string
|
|
*/
|
|
LWS_VISIBLE LWS_EXTERN const char *
|
|
lws_sql_purify(char *escaped, const char *string, int len);
|
|
|
|
/**
|
|
* lws_json_purify() - like strncpy but with escaping for json chars
|
|
*
|
|
* \param escaped: output buffer
|
|
* \param string: input buffer ('/0' terminated)
|
|
* \param len: output buffer max length
|
|
*
|
|
* Because escaping expands the output string, it's not
|
|
* possible to do it in-place, ie, with escaped == string
|
|
*/
|
|
LWS_VISIBLE LWS_EXTERN const char *
|
|
lws_json_purify(char *escaped, const char *string, int len);
|
|
|
|
/**
|
|
* lws_filename_purify_inplace() - replace scary filename chars with underscore
|
|
*
|
|
* \param filename: filename to be purified
|
|
*
|
|
* Replace scary characters in the filename (it should not be a path)
|
|
* with underscore, so it's safe to use.
|
|
*/
|
|
LWS_VISIBLE LWS_EXTERN void
|
|
lws_filename_purify_inplace(char *filename);
|
|
|
|
LWS_VISIBLE LWS_EXTERN int
|
|
lws_plat_write_cert(struct lws_vhost *vhost, int is_key, int fd, void *buf,
|
|
int len);
|
|
LWS_VISIBLE LWS_EXTERN int
|
|
lws_plat_write_file(const char *filename, void *buf, int len);
|
|
|
|
LWS_VISIBLE LWS_EXTERN int
|
|
lws_plat_read_file(const char *filename, void *buf, int len);
|
|
|
|
LWS_VISIBLE LWS_EXTERN int
|
|
lws_plat_recommended_rsa_bits(void);
|
|
///@}
|