接続の確立

コネクタ内で利用可能なオブジェクトは、"cdata.apachecouchdb" モジュールからアクセスできます。モジュールのオブジェクトを直接使用するには：

モジュールを以下のようにインポートします。
```
import cdata.apachecouchdb as mod
```
接続を確立するには、以下のような適切な接続文字列を使用してコネクタオブジェクトからconnect() メソッドを呼び出します。
```
mod.connect("User=abc123; Password=abcdef;")
```

Apache CouchDB への接続

Apache CouchDB は3種類の認証をサポートします。

Basic：基本的なユーザー名 / パスワード認証。
JWT：JWT トークンによる認証。
None：パブリックなデータベースへの匿名アクセス。

ユーザー（またはJWT トークン）が特定のデータベースだけにアクセスできるようにしたい場合は、Apache CouchDB インスタンスでadmin_only_all_dbs オプションを設定し、テーブルをリストするために本製品が必要とする"/_all_dbs" エンドポイントへのアクセス権をすべてのユーザーに付与する必要があります。そうしない場合、エンドポイントは認証エラーをスローするため本製品は接続することができません。

Basic 認証

データに接続するには以下を設定します。

AuthScheme：Basic。
Url：Apache CouchDB インスタンスのURL。例：http://localhost:5984
User：認証に使用されるApache CouchDB ユーザーアカウント。
Password：認証するユーザーに関連付けられたApache CouchDB パスワード。

JWT Authentication

The following connection properties are required and must always be specified:

AuthScheme: JWT.
Url: The Url of your Apache CouchDB instance. For example: http://localhost:5984.

From here you can:

1. Set the following so that the 本製品 automatically generates (and refreshes if applicable) the tokens for you:

Required

JWTSubject: The name of the user to assign to the JWT token.
JWTAlgorithm: The algorithm to use for the JWT token signature.
JWTKeyType: The type of the encryption key.
JWTKey: The encryption key used to sign the JWT token generated by the 本製品.

Optional

JWTIssuer: The issuer of the JWT token.
JWTExpiration: How long the JWT token should remain valid, in seconds.
JWTHeaders: A collection of extra headers that should be included in the JWT header.
JWTClaims: A collection of extra claims that should be included in the JWT payload.
CredentialsLocation: The location of the settings file where the JWT token is saved.

2. Or you can generate the tokens yourself manually and pass them to the 本製品 by using the JWTToken connection property.

Generating the key pair

When using asymmetric algorithms to sign the tokens, you must generate a private/public key pair. For that, a cryptographic library like OpenSSL can be used. For example:

# generate private key
openssl genrsa --out private_rsa256.pem 2048

# extract public key
openssl rsa -in private_rsa256.pem -pubout > public_rsa256.pem

JWT Configurations

Refer to CouchDB JWT Authentication Documentation for the following.

The alg and sub are required claims and will always be validated by the Apache CouchDB instance. Other required claims can be configured in the server (see required_claims). In that case, you must use JWTHeaders and JWTClaims so that the 本製品 can include those additional claims when generating the JWT token.

You can use roles_claim_name or the roles_claim_path options to assign roles to the JWT tokens.

Refer to the following example for configuring the server and the 本製品:

server configuration

[chttpd]
...
authentication_handlers = {chttpd_auth, jwt_authentication_handler}, {chttpd_auth, cookie_authentication_handler}, {chttpd_auth, default_authentication_handler}
admin_only_all_dbs = false
...

[jwt_auth]
...
required_claims = exp
roles_claim_path = my.nested._couchdb\.roles
rsa:rsa_256 = -----BEGIN PUBLIC KEY-----\nYOUR_PUBLIC_KEY\n-----END PUBLIC KEY-----\n
...

本製品 configuration

Url=http://localhost:5984;
JWTSubject=JWT User 1;
JWTAlgorithm=RS256;
JWTKeyType=PEMKEY_FILE;
JWTKey=PATH_TO_FOLDER\private_rsa256.pem;
JWTHeaders=kid : rsa_256 | Custom Header 1 : Test 1;
JWTClaims= my : eyJuZXN0ZWQiOnsiX2NvdWNoZGIucm9sZXMiOlsidXNlcjIiXX19 | Custom Claim 1 : Test 1;

Anonymous