Skip to content
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

Add unauthenticated HTTP REST interface #2844

Merged
merged 1 commit into from
Nov 18, 2014
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
1 change: 1 addition & 0 deletions src/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,7 @@ libbitcoin_server_a_SOURCES = \
net.cpp \
noui.cpp \
pow.cpp \
rest.cpp \
rpcblockchain.cpp \
rpcmining.cpp \
rpcmisc.cpp \
Expand Down
201 changes: 201 additions & 0 deletions src/rest.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-2012 The Bitcoin developers
// Distributed under the MIT/X11 software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#include <boost/algorithm/string.hpp>
#include "rpcserver.h"
#include "streams.h"
#include "utilstrencodings.h"
#include "core/block.h"
#include "core/transaction.h"
#include "version.h"
#include "main.h"

using namespace std;
using namespace json_spirit;

enum RetFormat {
RF_BINARY,
RF_HEX,
RF_JSON,
};

static const struct {
enum RetFormat rf;
const char *name;
} rf_names[] = {
{ RF_BINARY, "binary" }, // default, if match not found
{ RF_HEX, "hex" },
{ RF_JSON, "json" },
};

class RestErr {
public:
enum HTTPStatusCode status;
string message;
};

extern void TxToJSON(const CTransaction& tx, const uint256 hashBlock, Object& entry);
extern Object blockToJSON(const CBlock& block, const CBlockIndex* blockindex);

static RestErr RESTERR(enum HTTPStatusCode status, string message)
{
RestErr re;
re.status = status;
re.message = message;
return re;
}

static enum RetFormat ParseDataFormat(const string& format)
{
for (unsigned int i = 0; i < ARRAYLEN(rf_names); i++)
if (format == rf_names[i].name)
return rf_names[i].rf;

return rf_names[0].rf;
}

static bool ParseHashStr(string& strReq, uint256& v)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

const string& strReq?

{
if (!IsHex(strReq) || (strReq.size() != 64))
return false;

v.SetHex(strReq);
return true;
}

static bool rest_block(AcceptedConnection *conn,
string& strReq,
map<string, string>& mapHeaders,
bool fRun)
{
vector<string> params;
boost::split(params, strReq, boost::is_any_of("/"));

enum RetFormat rf = ParseDataFormat(params.size() > 1 ? params[1] : string(""));

string hashStr = params[0];
uint256 hash;
if (!ParseHashStr(hashStr, hash))
throw RESTERR(HTTP_BAD_REQUEST, "Invalid hash: " + hashStr);

if (mapBlockIndex.count(hash) == 0)
throw RESTERR(HTTP_NOT_FOUND, hashStr + " not found");

CBlock block;
CBlockIndex* pblockindex = mapBlockIndex[hash];
if (!ReadBlockFromDisk(block, pblockindex))
throw RESTERR(HTTP_NOT_FOUND, hashStr + " not found");

CDataStream ssBlock(SER_NETWORK, PROTOCOL_VERSION);
ssBlock << block;

switch (rf) {
case RF_BINARY: {
string binaryBlock = ssBlock.str();
conn->stream() << HTTPReply(HTTP_OK, binaryBlock, fRun, true, "application/octet-stream") << binaryBlock << std::flush;
return true;
}

case RF_HEX: {
string strHex = HexStr(ssBlock.begin(), ssBlock.end()) + "\n";;
conn->stream() << HTTPReply(HTTP_OK, strHex, fRun, false, "text/plain") << std::flush;
return true;
}

case RF_JSON: {
Object objBlock = blockToJSON(block, pblockindex);
string strJSON = write_string(Value(objBlock), false) + "\n";
conn->stream() << HTTPReply(HTTP_OK, strJSON, fRun) << std::flush;
return true;
}
}

// not reached
return true; // continue to process further HTTP reqs on this cxn
}

static bool rest_tx(AcceptedConnection *conn,
string& strReq,
map<string, string>& mapHeaders,
bool fRun)
{
vector<string> params;
boost::split(params, strReq, boost::is_any_of("/"));

enum RetFormat rf = ParseDataFormat(params.size() > 1 ? params[1] : string(""));

string hashStr = params[0];
uint256 hash;
if (!ParseHashStr(hashStr, hash))
throw RESTERR(HTTP_BAD_REQUEST, "Invalid hash: " + hashStr);

CTransaction tx;
uint256 hashBlock = 0;
if (!GetTransaction(hash, tx, hashBlock, true))
throw RESTERR(HTTP_NOT_FOUND, hashStr + " not found");

CDataStream ssTx(SER_NETWORK, PROTOCOL_VERSION);
ssTx << tx;

switch (rf) {
case RF_BINARY: {
string binaryTx = ssTx.str();
conn->stream() << HTTPReply(HTTP_OK, binaryTx, fRun, true, "application/octet-stream") << binaryTx << std::flush;
return true;
}

case RF_HEX: {
string strHex = HexStr(ssTx.begin(), ssTx.end()) + "\n";;
conn->stream() << HTTPReply(HTTP_OK, strHex, fRun, false, "text/plain") << std::flush;
return true;
}

case RF_JSON: {
Object objTx;
TxToJSON(tx, hashBlock, objTx);
string strJSON = write_string(Value(objTx), false) + "\n";
conn->stream() << HTTPReply(HTTP_OK, strJSON, fRun) << std::flush;
return true;
}
}

// not reached
return true; // continue to process further HTTP reqs on this cxn
}

static const struct {
const char *prefix;
bool (*handler)(AcceptedConnection *conn,
string& strURI,
map<string, string>& mapHeaders,
bool fRun);
} uri_prefixes[] = {
{ "/rest/tx/", rest_tx },
{ "/rest/block/", rest_block },
};

bool HTTPReq_REST(AcceptedConnection *conn,
string& strURI,
map<string, string>& mapHeaders,
bool fRun)
{
try {
for (unsigned int i = 0; i < ARRAYLEN(uri_prefixes); i++) {
unsigned int plen = strlen(uri_prefixes[i].prefix);
if (strURI.substr(0, plen) == uri_prefixes[i].prefix) {
string strReq = strURI.substr(plen);
return uri_prefixes[i].handler(conn, strReq, mapHeaders, fRun);
}
}
}
catch (RestErr& re) {
conn->stream() << HTTPReply(re.status, re.message + "\r\n", false, false, "text/plain") << std::flush;
return false;
}

conn->stream() << HTTPReply(HTTP_NOT_FOUND, "", false) << std::flush;
return false;
}

9 changes: 8 additions & 1 deletion src/rpcserver.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -946,11 +946,18 @@ void ServiceConnection(AcceptedConnection *conn)
if (mapHeaders["connection"] == "close")
fRun = false;

// Process via JSON-RPC API
if (strURI == "/") {
if (!HTTPReq_JSONRPC(conn, strRequest, mapHeaders, fRun))
break;

// Process via HTTP REST API
} else if (strURI.substr(0, 6) == "/rest/") {
if (!HTTPReq_REST(conn, strURI, mapHeaders, fRun))
break;

} else {
conn->stream() << HTTPError(HTTP_NOT_FOUND, false) << std::flush;
conn->stream() << HTTPReply(HTTP_NOT_FOUND, "", false) << std::flush;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this change from HTTPError to HTTPReply?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@laanwj Looks like an error to me.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you fix it?

break;
}
}
Expand Down
6 changes: 6 additions & 0 deletions src/rpcserver.h
Original file line number Diff line number Diff line change
Expand Up @@ -218,4 +218,10 @@ extern json_spirit::Value gettxout(const json_spirit::Array& params, bool fHelp)
extern json_spirit::Value verifychain(const json_spirit::Array& params, bool fHelp);
extern json_spirit::Value getchaintips(const json_spirit::Array& params, bool fHelp);

// in rest.cpp
extern bool HTTPReq_REST(AcceptedConnection *conn,
std::string& strURI,
std::map<std::string, std::string>& mapHeaders,
bool fRun);

#endif // BITCOIN_RPCSERVER_H