request.cpp File Reference

#include <rpc/request.h>
#include <fs.h>
#include <random.h>
#include <rpc/protocol.h>
#include <util/system.h>
#include <util/strencodings.h>

Include dependency graph for request.cpp:

Go to the source code of this file.

Functions
UniValue	JSONRPCRequestObj (const std::string &strMethod, const UniValue &params, const UniValue &id)
	JSON-RPC protocol. More...
UniValue	JSONRPCReplyObj (const UniValue &result, const UniValue &error, const UniValue &id)
std::string	JSONRPCReply (const UniValue &result, const UniValue &error, const UniValue &id)
UniValue	JSONRPCError (int code, const std::string &message)
static fs::path	GetAuthCookieFile (bool temp=false)
	Get name of RPC authentication cookie file. More...
bool	GenerateAuthCookie (std::string *cookie_out)
	Generate a new RPC authentication cookie and write it to disk. More...
bool	GetAuthCookie (std::string *cookie_out)
	Read the RPC authentication cookie from disk. More...
void	DeleteAuthCookie ()
	Delete RPC authentication cookie from disk. More...
std::vector< UniValue >	JSONRPCProcessBatchReply (const UniValue &in)
	Parse JSON-RPC batch reply into a vector. More...

Variables
static const std::string	COOKIEAUTH_USER = "__cookie__"
	Username used when cookie authentication is in use (arbitrary, only for recognizability in debugging/logging purposes) More...
static const std::string	COOKIEAUTH_FILE = ".cookie"
	Default name for auth cookie file. More...

Function Documentation

DeleteAuthCookie()

void DeleteAuthCookie

(

)

Delete RPC authentication cookie from disk.

Definition at line 124 of file request.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

GenerateAuthCookie()

bool GenerateAuthCookie

(

std::string *

cookie_out

)

Generate a new RPC authentication cookie and write it to disk.

the umask determines what permissions are used to create this file - these are set to 077 in init.cpp unless overridden with -sysperms.

Definition at line 76 of file request.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

GetAuthCookie()

bool GetAuthCookie

(

std::string *

cookie_out

)

Read the RPC authentication cookie from disk.

Definition at line 108 of file request.cpp.

Here is the call graph for this function:

GetAuthCookieFile()

static fs::path GetAuthCookieFile ( bool  temp = false )

static

Get name of RPC authentication cookie file.

Definition at line 67 of file request.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

JSONRPCError()

UniValue JSONRPCError	(	int	code,
		const std::string &	message
	)

Definition at line 51 of file request.cpp.

Here is the call graph for this function:

JSONRPCProcessBatchReply()

std::vector< UniValue > JSONRPCProcessBatchReply

(

const UniValue &

in

)

Parse JSON-RPC batch reply into a vector.

Definition at line 133 of file request.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

JSONRPCReply()

std::string JSONRPCReply	(	const UniValue &	result,
		const UniValue &	error,
		const UniValue &	id
	)

Definition at line 45 of file request.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

JSONRPCReplyObj()

UniValue JSONRPCReplyObj	(	const UniValue &	result,
		const UniValue &	error,
		const UniValue &	id
	)

Definition at line 33 of file request.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

JSONRPCRequestObj()

UniValue JSONRPCRequestObj	(	const std::string &	strMethod,
		const UniValue &	params,
		const UniValue &	id
	)

JSON-RPC protocol.

Bitcoin speaks version 1.0 for maximum compatibility, but uses JSON-RPC 1.1/2.0 standards for parts of the 1.0 standard that were unspecified (HTTP errors and contents of 'error').

1.0 spec: http://json-rpc.org/wiki/specification 1.2 spec: http://jsonrpc.org/historical/json-rpc-over-http.html

Definition at line 24 of file request.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

COOKIEAUTH_FILE

const std::string COOKIEAUTH_FILE = ".cookie"

static

Default name for auth cookie file.

Definition at line 64 of file request.cpp.

COOKIEAUTH_USER

const std::string COOKIEAUTH_USER = "__cookie__"

static

Username used when cookie authentication is in use (arbitrary, only for recognizability in debugging/logging purposes)

Definition at line 62 of file request.cpp.