【Python】pyjwt(RS256)のエンコード・デコード方法(公開鍵と秘密鍵を使用)

エンジニアライフスタイルブログを運営しているミウラ(@miumiu06171)です。

普段はフリーランスでシステムエンジニアをしております。

今回は、Pythonのpyjwt ＋ cryptographyを使ってRSA-SHA256(RS256)アルゴリズムで署名するときのエンコード(符号化)とデコード(復号化)する方法を紹介していきます。

動作確認には、Visual Studio Code (VS Code) を使用しているため、同様に確認したい方は、こちらの記事でVS CodeのPython開発環境を構築してみてください。

概要

pyjwt-token-rs256-algorithm-private-key-public-key

JSONのペイロードデータをRS256アルゴリズムと秘密鍵(Private Key)でエンコードし、JWTトークンを生成します。

そして、RS256アルゴリズム、JWTトークン、公開鍵(Public Key)を使ってデコードし、元のJSONのペイロードデータを読み取れるか確認していきます。

事前準備

RSA-SHA256(RS256)アルゴリズムで署名するために事前準備として秘密鍵と公開鍵を生成します。

秘密鍵の生成(ssh-keygen)

秘密鍵を生成するには、以下のssh-keygenコマンドを実行します。

ssh-keygen -t rsa -b 4096 -m PEM -f id_rsa

1	ssh-keygen -t rsa -b 4096 -m PEM -f id_rsa

カレントディレクトリに「id_rsa」というファイル名の秘密鍵が生成されていればオッケーです。

公開鍵の生成(openssl)

次に公開鍵を生成するには、以下のopensslコマンドを実行します。

openssl rsa -in id_rsa -pubout -outform PEM -out id_rsa.pub

1	openssl rsa -in id_rsa -pubout -outform PEM -out id_rsa.pub

カレントディレクトリに「id_rsa.pub」というファイル名の公開鍵が生成されていればオッケーです。

Windowsでopensslコマンドが実行できないときの対処方法

公開鍵の生成でopensslコマンドが実行できなかった場合、以下の記事をもとにWindowsにopensslをインストールしてから再度試してみてください。

【TIPS】Windowsでopensslコマンドが実行できないときの対処方法Windowsにopensslをインストールする手順と動作確認方法を紹介しています。 WindowsのPowerShellなどで「openssl : 用語 'openssl' は、コマンドレット、関数、スクリプトファイル、または操作可能なプログラムの名前として認識されません。名前が正しく記述されていることを確認し、パスが含まれている場合はそのパスが正しいことを確認してから、再試行してください。」というエラーが表示されたら、本記事でopensslをインストールしてください。 ...

pyjwtでRS256アルゴリズム署名を行う方法

pyjwtインストール

Pythonのpyjwtライブラリをインストールするため、以下のコマンドを実行します。

pip install pyjwt

1	pip install pyjwt

cryptographyインストール

Pythonのcryptographyライブラリをインストールするため、以下のコマンドを実行します。

pip install cryptography

1	pip install cryptography

RS256と秘密鍵(id_rsaファイル)でpyjwtのエンコード

RS256と秘密鍵(id_rsaファイル)でpyjwtエンコードするサンプルコードは、以下のとおりです。

import jwt

priv_key_path = "id_rsa"
pub_key_path = "id_rsa.pub"

payload_data = {
    "id": "1000",
    "name": "Sato",
    "email": "sato@test.com"
}

with open(priv_key_path) as private_key:
    encoded_jwt = jwt.encode(payload_data, private_key.read(), algorithm="RS256")
    print(encoded_jwt)

with open(pub_key_path) as public_key:
    decoded_jwt = jwt.decode(encoded_jwt, public_key.read(), algorithms=["RS256"])
    print(decoded_jwt)

import jwt

priv_key_path = "id_rsa"

pub_key_path = "id_rsa.pub"

payload_data = {

"id": "1000",

"name": "Sato",

"email": "sato@test.com"

}

with open(priv_key_path) as private_key:

encoded_jwt = jwt.encode(payload_data, private_key.read(), algorithm="RS256")

print(encoded_jwt)

with open(pub_key_path) as public_key:

decoded_jwt = jwt.decode(encoded_jwt, public_key.read(), algorithms=["RS256"])

print(decoded_jwt)

pyjwtのencodeメソッドの引数にペイロード、秘密鍵、アルゴリズムの種類を指定してエンコードを行います。

RS256と公開鍵(id_rsa.pubファイル)でpyjwtのデコード

RS256と公開鍵(id_rsa.pubファイル)でpyjwtデコードするサンプルコードは、以下のとおりです。

import jwt

priv_key_path = "id_rsa"
pub_key_path = "id_rsa.pub"

payload_data = {
    "id": "1000",
    "name": "Sato",
    "email": "sato@test.com"
}

with open(priv_key_path) as private_key:
    encoded_jwt = jwt.encode(payload_data, private_key.read(), algorithm="RS256")
    print(encoded_jwt)

with open(pub_key_path) as public_key:
    decoded_jwt = jwt.decode(encoded_jwt, public_key.read(), algorithms=["RS256"])
    print(decoded_jwt)