mcommit's message

ソフトウェア開発の仕事をしているsimotinといいます。記事の内容でご質問やご意見がありましたらお気軽にコメントしてください\^o^/

Pocoを使ってHTTPS通信するコードを書いてみる

少し前に知ったのですが、C++にPocoというとても便利なライブラリがあります。
HTTPS通信を実装する際に使ったのですが、便利だったので使い方等を書いておきたいと思います。

幅広い機能

PocoにはJSONXMLのファイルフォーマット処理の機能があります。
また、ほかのライブラリに依存はしますが、SQLite,MySQL,ODBCのようなデータベースに関する機能、
FTPやHTTPといったネットワークに関わる機能など幅広い機能も提供されています。

https://pocoproject.org/features.html

ライセンスは?

Boost Software Licenseで公開されています。
基本的にはライブラリを利用するにあたって、ソースコード著作権の表示があれば(公開を含めて)無償で利用できるそうです。

https://pocoproject.org/license.html

使い方

ここからソース一式をダウンロードします。
https://pocoproject.org/download/index.html

私が利用したのはUnix/Linux系向けの方ですが、Windows用のソースも提供されているようです。(VisualStdioでビルドできるようですね)
タイトルにも書きました、「HTTPS通信」には「Complete Edition」の方をダウンロードする必要があります。
HTTPS通信の機能はOpenSSLに依存しています。ここでは、OpenSSLはインストール済みのものとして説明します。

ビルドについて

Pocoの実体は各機能を提供する共有ライブラリ(.so)として生成されます。
./configure時に --static をつけることで静的ライブラリとしてビルドすることも可能です。
※試していませんがCMakeにも対応しているみたいです。

オプションがたくさんありますが、


$ ./configure --help

でコンフィグレーションに関するオプション情報を確認できます。

ビルド対象とするコンポーネントについても--omit オプションで取捨選択できます。
どのようなコンポーネントがあるかは、componentsというファイルに一覧が記載されています。


$cat components
CppUnit
CppUnit/WinTestRunner
Foundation
XML
JSON
Util
Net
Crypto
NetSSL_OpenSSL
Data
Data/SQLite
Data/ODBC
Data/MySQL
MongoDB
Zip
PageCompiler
PageCompiler/File2Page

ビルドまでのコマンド実行例


$ wget https://pocoproject.org/releases/poco-1.7.8/poco-1.7.8p3-all.tar.gz
$ tar xzfv poco-1.7.8p3-all.tar.gz
$ cd poco-1.7.8p3-all
$ ./configure --no-tests --no-wstring --omit=Data/SQLite,Data/MySQL,Data/ODBC,Zip,MongoDB,PageCompiler,PageCompiler/File2Page
$ make
$ sudo make install
$ sudo ldconfig

./configure は一瞬で終わるのですが、ビルドにはそれなりに時間がかかると思うので不要な手順は省略するようにオプションを指定した方がよさそうです。


デフォルトでは、ビルドされたライブラリ(.so)は /usr/local/lib にインストールされます。
ヘッダファイルは、/usr/local/include/Poco 以下にインストールされます。

ライブラリを使う前に ldconfig でライブラリ情報は更新しておく必要があります。

HTTPS通信のコードを書いてみる。

早速HTTPS通信をするコードを書いてみます。

#include <string>
#include <iostream>
#include <sstream>

#include <Poco/URI.h>
#include <Poco/Net/HTTPSClientSession.h>
#include <Poco/Net/HTTPRequest.h>
#include <Poco/Net/HTTPResponse.h>
#include <Poco/StreamCopier.h>
#include "Poco/Net/Context.h"
#include "Poco/Net/SSLManager.h"
#include "Poco/Net/AcceptCertificateHandler.h"
using namespace std;

int main(int argc, char **argv)
{

	// SSL接続情報 初期化
	Poco::Net::initializeSSL();
      Poco::Net::SSLManager::InvalidCertificateHandlerPtr ptrHandler ( new Poco::Net::AcceptCertificateHandler(false) );
      Poco::Net::Context::Ptr ptrContext ( new Poco::Net::Context(Poco::Net::Context::CLIENT_USE, "") );
      Poco::Net::SSLManager::instance().initializeClient(0, ptrHandler, ptrContext);


	try {
		Poco::URI uri("https://www.yahoo.co.jp/");
		Poco::Net::HTTPSClientSession session(uri.getHost(), uri.getPort());
		Poco::Net::HTTPRequest req("GET", uri.getPath(), Poco::Net::HTTPMessage::HTTP_1_1);

		// リクエスト送信
		ostream& ss = session.sendRequest(req);

		// レスポンス受信
		Poco::Net::HTTPResponse res;
		istream& rs = session.receiveResponse(res);

		stringstream sstr;
		Poco::StreamCopier::copyStream(rs, sstr);
		string response = sstr.str();
		cout << string("response:") + response << endl;
	}
	catch ( Poco::Exception& ex )
	{
		string msg = string("Poco Exception : ") + ex.what() + ", message: " + ex.message();
		cout << msg << endl;
	}

	return 0;
}

コンパイルと実行

HTTPS通信でリンクする必要があるライブラリはPocoNetSSLになります。
※StreamCopierとか使っているのでたぶんPocoUtilとかもリンクする必要があるように思いますが、PocoNetSSLでリンク指定しているのか、手元の環境では、ビルド時に指定しなくても動きました。



$ g++ main.cpp -lPocoNetSSL #上記のコードをmain.cppで保存した場合
$ ./a.out # 正常に実行されると、yahooのトップページが取得・表示されます

pocoのクラスについて

サーバーとのHTTPS通信は HTTPSClientSession クラスを使って行います。
通信を始める前にSSLManagerの接続情報を初期化しておく必要があります。
OpenSSL をインストールしていれば上記のようなコードで、OpenSSL のデフォルトの証明書を使って通信されます。

認証に使用する証明書を指定したい場合や、パスフレーズを使う場合は、Context クラスに証明書のファイルパスやパスフレーズ等を細かく指定する必要があります。
パスフレーズを使う場合は、PrivateKeyPassphraseHandler クラスを継承して、ライブラリ側にパスフレーズを受け渡しするコードを書く必要があります。

Poco のクラスのリファレンスは、

https://pocoproject.org/docs/

にあります。

HTTP通信してみるコード

ちなみに、SSLを使わない通常のHTTP通信をする場合は、 HTTPSession クラスを使うことで可能です。

#include <string>
#include <iostream>
#include <sstream>

#include <Poco/URI.h>
#include <Poco/Net/HTTPClientSession.h>
#include <Poco/Net/HTTPRequest.h>
#include <Poco/Net/HTTPResponse.h>
#include <Poco/StreamCopier.h>
using namespace std;

int main(int argc, char **argv)
{
	try {
		Poco::URI uri("http://www.hatena.ne.jp/");
		Poco::Net::HTTPClientSession session(uri.getHost(), uri.getPort());
		Poco::Net::HTTPRequest req("GET", uri.getPath(), Poco::Net::HTTPMessage::HTTP_1_1);

		// リクエスト送信
		ostream& ss = session.sendRequest(req);

		// レスポンス受信
		Poco::Net::HTTPResponse res;
		istream& rs = session.receiveResponse(res);

		stringstream sstr;
		Poco::StreamCopier::copyStream(rs, sstr);
		string response = sstr.str();
		cout << string("response:") + response << endl;
	}
	catch ( Poco::Exception& ex )
	{
		string msg = string("Poco Exception : ") + ex.what() + ", message: " + ex.message();
		cout << msg << endl;
	}

	return 0;
}


依存するクラスが減るのでコードも少しシンプルになりますね。
HTTP通信の場合はビルドにリンクするライブラリはPocoNetの方になります。

参考

Pocoの各コンポーネントにはサンプルプログラムが付属しています。
HTTPS通信の場合は、NetSSL_OpenSSL/samplesに

  • HTTPSでのダウンロード(HTTPSクライアント)
  • 時刻サーバ
  • Twitterクライアント

といったサンプルコードがあります。

感想

C++のライブラリというとBoostくらいしか知りませんでしたが、Pocoは非常に便利・高機能だなという印象を受けました。
あと、リファレンスもきちんと提供されていて、クラスの階層が奇麗なのでわからないことがあった時もソースを追っかけやすかったです。