mirror
/
transmission
mirror of https://github.com/transmission/transmission
1
0
Fork 0
Code Issues Releases Wiki Activity
transmission/libtransmission/rpc-server.h

70 lines
2.0 KiB
C
Raw Normal View History

RPC/IPC redesign
2008-05-18 16:44:30 +00:00
/*
Licensing changes: 1. add the option the code to be used under GPLv2 or GPLv3; previously only GPLv2 was allowed 2. add the "proxy option" as described in GPLv3 so we can add future licenses without having to bulk-edit everything again :) 3. remove the awkward "exception for MIT code in Mac client" clause; it was unnecessary and confusing.
2014-01-19 01:09:44 +00:00
* This file Copyright (C) 2008-2014 Mnemosyne LLC
RPC/IPC redesign
2008-05-18 16:44:30 +00:00
*
Copyedit the license's revised text: (1) remove unnecessary repitition use of the word 'license' from the top of the header and source files (2) add the standard 'we hope it's useful, but no warranty' clause to COPYING (3) make explicit that linking OpenSSL is allowed (see https://people.gnome.org/~markmc/openssl-and-the-gpl.html for background) (4) sync the Qt and GTK+ clients' license popups with COPYING's revised text
2014-01-21 03:10:30 +00:00
* It may be used under the GNU GPL versions 2 or 3
Licensing changes: 1. add the option the code to be used under GPLv2 or GPLv3; previously only GPLv2 was allowed 2. add the "proxy option" as described in GPLv3 so we can add future licenses without having to bulk-edit everything again :) 3. remove the awkward "exception for MIT code in Mac client" clause; it was unnecessary and confusing.
2014-01-19 01:09:44 +00:00
* or any future license endorsed by Mnemosyne LLC.
RPC/IPC redesign
2008-05-18 16:44:30 +00:00
*
*/
Ensure include guard is the first non-comment line
2017-11-14 20:21:28 +00:00
#pragma once
(libT) add #ifdefs to ensure that client apps don't #include private libtransmission headers.
2008-11-24 20:17:36 +00:00
#ifndef __TRANSMISSION__
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes.
2017-04-19 12:04:45 +00:00
#error only libtransmission should #include this header.
(libT) add #ifdefs to ensure that client apps don't #include private libtransmission headers.
2008-11-24 20:17:36 +00:00
#endif
use '#pragma once' instead of #ifndef..#define..#endif guards
2016-03-29 16:37:21 +00:00
#include "variant.h"
RPC/IPC redesign
2008-05-18 16:44:30 +00:00
refactor: prefer "using" over "typedef" (#1883) * refactor: prefer "using" over "typedef"
2021-10-06 14:26:07 +00:00
struct tr_rpc_server;
RPC/IPC redesign
2008-05-18 16:44:30 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes.
2017-04-19 12:04:45 +00:00
tr_rpc_server* tr_rpcInit(tr_session* session, tr_variant* settings);
RPC/IPC redesign
2008-05-18 16:44:30 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes.
2017-04-19 12:04:45 +00:00
void tr_rpcClose(tr_rpc_server** freeme);
RPC/IPC redesign
2008-05-18 16:44:30 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes.
2017-04-19 12:04:45 +00:00
void tr_rpcSetEnabled(tr_rpc_server* server, bool isEnabled);
RPC/IPC redesign
2008-05-18 16:44:30 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
bool tr_rpcIsEnabled(tr_rpc_server const* server);
RPC/IPC redesign
2008-05-18 16:44:30 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes.
2017-04-19 12:04:45 +00:00
void tr_rpcSetPort(tr_rpc_server* server, tr_port port);
RPC/IPC redesign
2008-05-18 16:44:30 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
tr_port tr_rpcGetPort(tr_rpc_server const* server);
RPC/IPC redesign
2008-05-18 16:44:30 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
void tr_rpcSetUrl(tr_rpc_server* server, char const* url);
(trunk) #1538 "Make Web UI URL configurable" -- added to trunk. Patch by wereHamster
2010-12-12 18:22:11 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
char const* tr_rpcGetUrl(tr_rpc_server const* server);
(trunk) #1538 "Make Web UI URL configurable" -- added to trunk. Patch by wereHamster
2010-12-12 18:22:11 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
int tr_rpcSetTest(tr_rpc_server const* server, char const* whitelist, char** allocme_errmsg);
RPC ACL: (1) add a new call for testing ACLs (2) add wildcard notation support (3) add regression tests for the ACL tester and wildcard handler
2008-06-04 17:14:58 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes.
2017-04-19 12:04:45 +00:00
void tr_rpcSetWhitelistEnabled(tr_rpc_server* server, bool isEnabled);
add a separate flag for enabling/disabling the rpc address whitelist
2008-10-01 22:59:29 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
bool tr_rpcGetWhitelistEnabled(tr_rpc_server const* server);
add a separate flag for enabling/disabling the rpc address whitelist
2008-10-01 22:59:29 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
void tr_rpcSetWhitelist(tr_rpc_server* server, char const* whitelist);
RPC/IPC redesign
2008-05-18 16:44:30 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
char const* tr_rpcGetWhitelist(tr_rpc_server const* server);
get RPC password protections working in libT and the gtk+ client. mac, daemon, and cli need to be synced.
2008-06-05 16:23:03 +00:00
mitigate dns rebinding attacks against daemon
2018-01-11 18:00:41 +00:00
void tr_rpcSetHostWhitelistEnabled(tr_rpc_server* server, bool isEnabled);
void tr_rpcSetHostWhitelist(tr_rpc_server* server, char const* whitelist);
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
void tr_rpcSetPassword(tr_rpc_server* server, char const* password);
get RPC password protections working in libT and the gtk+ client. mac, daemon, and cli need to be synced.
2008-06-05 16:23:03 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
char const* tr_rpcGetPassword(tr_rpc_server const* server);
get RPC password protections working in libT and the gtk+ client. mac, daemon, and cli need to be synced.
2008-06-05 16:23:03 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
void tr_rpcSetUsername(tr_rpc_server* server, char const* username);
get RPC password protections working in libT and the gtk+ client. mac, daemon, and cli need to be synced.
2008-06-05 16:23:03 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
char const* tr_rpcGetUsername(tr_rpc_server const* server);
get RPC password protections working in libT and the gtk+ client. mac, daemon, and cli need to be synced.
2008-06-05 16:23:03 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes.
2017-04-19 12:04:45 +00:00
void tr_rpcSetPasswordEnabled(tr_rpc_server* server, bool isEnabled);
get RPC password protections working in libT and the gtk+ client. mac, daemon, and cli need to be synced.
2008-06-05 16:23:03 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
bool tr_rpcIsPasswordEnabled(tr_rpc_server const* session);
(libT) fix a couple of compiler warnings from gcc -Wmissing-prototypes -Wdeclaration-after-statement
2008-08-15 20:28:43 +00:00
configure anti brute force (#1447) * add brute force configuration options
2020-11-14 18:43:42 +00:00
bool tr_rpcGetAntiBruteForceEnabled(tr_rpc_server const* server);
void tr_rpcSetAntiBruteForceEnabled(tr_rpc_server* server, bool is_enabled);
int tr_rpcGetAntiBruteForceThreshold(tr_rpc_server const* server);
void tr_rpcSetAntiBruteForceThreshold(tr_rpc_server* server, int badRequests);
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
char const* tr_rpcGetBindAddress(tr_rpc_server const* server);