Node.jsのdecipher.final()メソッドの使い方を徹底解説

Node.jsのdecipher.final()メソッドは、decipherオブジェクトが保持する残りのデータを含むバッファ（Buffer）または文字列を返すために使用されます。このメソッドは、cryptoモジュールのDecipherクラスに組み込まれているメソッドの1つです。

重要な注意点として、decipher.final()メソッドを一度呼び出した後は、同じdecipherオブジェクトでそれ以上データを復号化することはできません。また、final()メソッドを複数回呼び出すとエラーがスローされます。

構文

decipher.final([outputEncoding])

パラメータ

このメソッドが受け取るパラメータは以下の通りです。

• outputEncoding – 出力データのエンコーディングを指定します。文字列型のパラメータで、hex、base64、utf8などの値を指定できます。省略した場合はBufferオブジェクトが返されます。

戻り値

outputEncodingを指定した場合は文字列が、指定しなかった場合はBufferオブジェクトが返されます。この戻り値には、復号化処理の最後に残されたデータが含まれています。

例1

まず、「decipherFinal.js」という名前のファイルを作成し、以下のコードをコピーしてください。ファイル作成後、次のコマンドでコードを実行します。

node decipherFinal.js

decipherFinal.js

// decipher.final()メソッドの使用例

// cryptoモジュールのインポート
const crypto = require('crypto');

// AESアルゴリズムの初期化
const algorithm = 'aes-192-cbc';
// 鍵の生成に使用するパスワード
const password = '12345678123456789';

// decipherオブジェクト用の鍵を取得
const key = crypto.scryptSync(password, 'old data', 24);

// 固定のIV（初期化ベクトル）を設定
const iv = Buffer.alloc(16, 0);

const decipher = crypto.createDecipheriv(algorithm, key, iv);

// 復号化対象の暗号文
const encrypted1 =
'a05e87569f3f04234812ae997da5684944c32b8776fae676b4abe9074b31cd2a';

// update()メソッドで暗号文を復号化
let decryptedValue1 = decipher.update(encrypted1, 'hex', 'utf8');

// final()メソッドで残りのデータを取得して連結
decryptedValue1 += decipher.final('utf8');

// 結果を出力
console.log("復号化された値 -- " + decryptedValue1);

出力

C:\home\node>> node decipherFinal.js
Decrypted value -- Welcome to tutorials point

例2

続いて、もう1つの例を見てみましょう。この例では、update()とfinal()の結果をそれぞれ配列に格納してから結合して出力しています。

// decipher.final()メソッドの使用例

// cryptoモジュールのインポート
const crypto = require('crypto');

// AESアルゴリズムの初期化
const algorithm = 'aes-192-cbc';
// 鍵の生成に使用するパスワード
const password = '12345678123456789';

// decipherオブジェクト用の鍵を取得
const key = crypto.scryptSync(password, 'old data', 24);

// 固定のIV（初期化ベクトル）を設定
const iv = Buffer.alloc(16, 0);

const decipher = crypto.createDecipheriv(algorithm, key, iv);

// 復号化対象の暗号文
const encrypted =
'a05e87569f3f04234812ae997da5684944c32b8776fae676b4abe9074b31cd2a';

// 結果を格納する配列
var buf = [];

// update()メソッドでデータを復号化
let decrypted = decipher.update(encrypted, 'hex', 'utf8');

// 復号化したデータをバッファにプッシュ
buf.push(decrypted);
buf.push(decipher.final('utf8'));

// 結果を出力
console.log(buf.join(' '));

出力

C:\home\node>> node decipherFinal.js
Welcome to tutor ials point

例2の出力に余分なスペースが含まれているのは、update()とfinal()の結果をスペース区切りで結合（join(' ')）しているためです。実際の開発では、例1のように文字列を直接連結するか、join('')を使ってスペースなしで結合するのがおすすめです。

まとめ

decipher.final()メソッドは、復号化処理の最後に必ず呼び出す必要がある重要なメソッドです。暗号化時に付与されたパディングの残りブロックを処理し、完全な平文を取得する役割を担います。一度呼び出すとそのdecipherオブジェクトは再利用できず、エラーが発生するため、新しいデータを復号化する場合は新しくdecipherオブジェクトを作成しましょう。