PdfTk::PtlEncrypt クラス

#include <PtlEncrypt.h>

PdfTk::PtlEncrypt の継承関係図

公開型
enum	FILTER_TYPE { FILTER_STANDARD = 1 , FILTER_PUBKEY = 2 }
enum	ENCRYPT_COMPONENT { ENCRYPT_ALL = 1 , ENCRYPT_EXCEPT_METADATA = 2 , ENCRYPT_ONLY_ATTACHED_FILE = 3 }

公開メンバ関数
int	getHandle () const
	PtlEncrypt (FILTER_TYPE filterType)
	コンストラクタ
	PtlEncrypt (const PtlEncrypt &obj)
	コピーコンストラクタ
virtual	~PtlEncrypt ()
	デストラクタ
PtlEncrypt &	operator= (const PtlEncrypt &obj)
	コピーオペレータ
FILTER_TYPE	getFilterType () const
	暗号化のフィルターを取得。
int	getKeyLength () const
	キー長を取得。
void	setKeyLength (int keyLength)
	キー長を設定。
ENCRYPT_COMPONENT	getEncryptComponent () const
	暗号化する文書コンポーネントを取得。
void	setEncryptComponent (ENCRYPT_COMPONENT component)
	暗号化する文書コンポーネントの設定。
const PtlEncryptPermission &	getPermission () const
	ユーザアクセス許可フラグを取得。
void	setPermission (const PtlEncryptPermission &perm)
	ユーザアクセス許可フラグを設定。

詳解

PDFのセキュリティハンドラおよび暗号化情報を表現したクラスです。
すべてのEncryptクラスのベースクラスです。

PtlEncrypt.h の 20 行目に定義があります。

列挙型メンバ詳解

ENCRYPT_COMPONENT

enum PdfTk::PtlEncrypt::ENCRYPT_COMPONENT

暗号化する文書コンポーネント

列挙値
ENCRYPT_ALL	文書の全てのコンテンツを暗号化
ENCRYPT_EXCEPT_METADATA	文書のメタデータを除く全てのコンテンツを暗号化
ENCRYPT_ONLY_ATTACHED_FILE	添付ファイルのみを暗号化(AES暗号化のみで有効)

PtlEncrypt.h の 35 行目に定義があります。

FILTER_TYPE

enum PdfTk::PtlEncrypt::FILTER_TYPE

セキュリティハンドラのタイプ
標準セキュリティハンドラのみ対応しています。

列挙値
FILTER_STANDARD	標準セキュリティハンドラ
FILTER_PUBKEY	公開キーセキュリティハンドラ

PtlEncrypt.h の 27 行目に定義があります。

構築子と解体子

PtlEncrypt() [1/2]

PdfTk::PtlEncrypt::PtlEncrypt

(

FILTER_TYPE

filterType

)

コンストラクタ

引数

filterType

フィルタータイプ

例外

PtlException

PtlEncrypt() [2/2]

PdfTk::PtlEncrypt::PtlEncrypt

(

const PtlEncrypt &

obj

)

コピーコンストラクタ

引数

obj	コピー元オブジェクト。

例外

PtlException

関数詳解

getEncryptComponent()

ENCRYPT_COMPONENT PdfTk::PtlEncrypt::getEncryptComponent

(

)

const

暗号化する文書コンポーネントを取得。

戻り値

暗号化する文書コンポーネント

例外

PtlException

getFilterType()

FILTER_TYPE PdfTk::PtlEncrypt::getFilterType

(

)

const

暗号化のフィルターを取得。

戻り値

暗号化のフィルタータイプ

例外

PtlException

getKeyLength()

int PdfTk::PtlEncrypt::getKeyLength

(

)

const

キー長を取得。

例外

PtlException

getPermission()

const PtlEncryptPermission & PdfTk::PtlEncrypt::getPermission

(

)

const

ユーザアクセス許可フラグを取得。

戻り値

ユーザアクセス許可フラグ。
PtlEncryptPermissionのサブクラスPtlEncryptPermissionType1若しくはPtlEncryptPermissionType2。

例外

PtlException

operator=()

PtlEncrypt & PdfTk::PtlEncrypt::operator=

(

const PtlEncrypt &

obj

)

コピーオペレータ

引数

obj	コピー元オブジェクト。

例外

PtlException

setEncryptComponent()

void PdfTk::PtlEncrypt::setEncryptComponent

(

ENCRYPT_COMPONENT

component

)

暗号化する文書コンポーネントの設定。

40ビットRC4の暗号化に対してENCRYPT_EXCEPT_METADATAを設定しても無視されます。

RC4の暗号化に対してENCRYPT_ONLY_ATTACHED_FILEを設定しても無視されます。
ENCRYPT_ONLY_ATTACHED_FILEを設定する場合、ユーザーパスワードは必須です。
また添付ファイルのみを暗号化するので、ユーザアクセス許可フラグが設定されているとNEED_OWNER_PASSWORDのエラーとなります。

引数

component

暗号化する文書コンポーネント

例外

PtlException

setKeyLength()

void PdfTk::PtlEncrypt::setKeyLength

(

int

keyLength

)

キー長を設定。

引数

keyLength

キー長。128,256の値でなければいけません。

例外

PtlException

setPermission()

void PdfTk::PtlEncrypt::setPermission

(

const PtlEncryptPermission &

perm

)

ユーザアクセス許可フラグを設定。

この関数は標準セキュリティハンドラでのみ有効です。
公開キーセキュリティハンドラではPtlEncryptPubKeyでアクセス権限を設定して下さい。

引数

perm	ユーザアクセス許可フラグ。 PtlEncryptPermissionのサブクラスPtlEncryptPermissionType1若しくはPtlEncryptPermissionType2。

例外

PtlException