接続のエクスポート
Keeperコネクションマネージャーから接続データをエクスポート
概要
本ページでは、Pythonスクリプトを使用して、接続データと接続パラメータをJSONファイルにエクスポートする方法の1つについて取り扱います。エクスポートされたファイルは、別の Keeperコネクションマネージャーのインスタンスへ接続をインポート (こちらのページを参照) したり、Keeperコネクションマネージャーのクラウドバージョンへの移行に使用したりできます。
本ページに記載の例は、MySQLデータベースを使用したKeeperコネクションマネージャーの標準であるDocker自動インストール方法に基づいています。
1. ローカルマシンへのMySQLポートを開く
PythonファイルがDockerコンテナ内のデータベースをクエリできるようにするには、/etc/kcm-setup/docker-compose.ymlファイルを編集し、以下のように「ports」セクションを「db」コンテナに追加します。
db:
image: keeper/guacamole-db-mysql :2
restart: unless-stopped
environment:
ACCEPT EULA: "Y"
GUACAMOLE_DATABASE: "guacamole_db"
GUACAMOLE_USERNAME: "guacamole_user"
GUACAMOLE_PASSWORD: "XXXXXXXXXXXXXXXXXXXXXXXXX"
GUACAMOLE_ADMIN_PASSWORD: "XXXXXXXXXXXXXXXXXXXXXXXXX"
MYSQL_ROOT_PASSWORD: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
LOG_LEVEL: "debug"
ports:
- "3306:3306" Docker Composeの更新を適用するには、以下の手順で行います。
自動インストールスクリプト (auto-docker) を使用している場合
kcm-setup.runスクリプトが保存されている場所に移動し、以下を実行します。sudo ./kcm-setup.run applyDocker Compose インストールの場合
/etc/kcm-setupフォルダに移動し、以下を実行します。docker compose up -d
2. Pythonモジュールをインストールする
インスタンスにすでにPython3がインストールされている前提で、必要なPythonモジュールをインストールします。
pip3 install mysql-connector-python
pip3 install pyyamlお使いのオペレーティングシステムに応じて、以下のコマンドを使用してpython3-pipをインストールしてください。
CentOS / RHELの場合
sudo yum install python3-pipUbuntuの場合
sudo apt install python3-pip
3. エクスポートスクリプトを作成する
以下のコードをコピーしてexport.pyというファイルに貼り付け、Keeperコネクションマネージャーの インスタンス (kcm-setup.runファイルと同じ場所) に配置します。このPythonスクリプトは以下を実行します。
標準
/etc/kcm-setup/フォルダ内のdocker-compose.ymlファイルを特定する。MySQLの認証情報を取得し、データベースに接続する。
接続情報をエクスポートし、同じフォルダにexport.jsonというファイルを作成する。
環境によっては、ファイルを編集する必要がある場合があります。
import mysql.connector
import json
import yaml
# docker-compose.yml ファイルのパス
docker_compose_file = '/etc/kcm-setup/docker-compose.yml'
# docker-compose.yml からデータベースの認証情報を抽出する関数
def get_db_config_from_compose():
with open(docker_compose_file, 'r') as file:
# docker-compose の YAML ファイルを読み込む
compose_data = yaml.safe_load(file)
# 'db' サービスから必要な情報を抽出する
db_service = compose_data['services']['db']
environment = db_service['environment']
db_name = environment.get('GUACAMOLE_DATABASE', 'guacamole_db')
db_user = environment.get('GUACAMOLE_USERNAME', 'guacamole_user')
db_password = environment.get('GUACAMOLE_PASSWORD', 'password') # 設定がない場合のデフォルト値
return {
'host': 'localhost', # Docker内にあるため、ローカルのデータベースと仮定
'user': db_user,
'password': db_password,
'database': db_name,
'port': 3306 # MySQL のデフォルトポート
}
def build_connection_group_paths(cursor):
"""
親子関係を解決しながら、グループIDとその完全パスをマッピングするディクショナリを構築する
"""
cursor.execute("SELECT connection_group_id, parent_id, connection_group_name FROM guacamole_connection_group")
groups = cursor.fetchall()
group_paths = {}
def resolve_path(group_id):
if group_id is None:
return "ROOT"
if group_id in group_paths:
return group_paths[group_id]
# グループの詳細を取得
group = next(g for g in groups if g['connection_group_id'] == group_id)
parent_path = resolve_path(group['parent_id'])
full_path = f"{parent_path}/{group['connection_group_name']}"
group_paths[group_id] = full_path
return full_path
# すべてのグループのパスを解決する
for group in groups:
resolve_path(group['connection_group_id'])
return group_paths
# すべての接続、ユーザー、グループ、属性を取得するSQLクエリ
query = """
SELECT
c.connection_id,
c.connection_name AS name,
c.protocol,
cp.parameter_name,
cp.parameter_value,
e.name AS entity_name,
e.type AS entity_type,
g.connection_group_id,
g.parent_id,
g.connection_group_name AS group_name,
ca.attribute_name,
ca.attribute_value
FROM
guacamole_connection c
LEFT JOIN
guacamole_connection_parameter cp ON c.connection_id = cp.connection_id
LEFT JOIN
guacamole_connection_attribute ca ON c.connection_id = ca.connection_id
LEFT JOIN
guacamole_connection_group g ON c.parent_id = g.connection_group_id
LEFT JOIN
guacamole_connection_permission p ON c.connection_id = p.connection_id
LEFT JOIN
guacamole_entity e ON p.entity_id = e.entity_id;
"""
def export_to_json(db_config):
try:
# データベースに接続する
conn = mysql.connector.connect(**db_config)
cursor = conn.cursor(dictionary=True) # 辞書形式のカーソルで扱いやすくする
# 接続グループのパスを構築する
connection_group_paths = build_connection_group_paths(cursor)
# クエリを実行する
cursor.execute(query)
rows = cursor.fetchall()
# データを所定の形式に整形する
connections = {}
for row in rows:
conn_id = row['connection_id']
if conn_id not in connections:
# 接続グループのパスを解決
group_path = connection_group_paths.get(row['connection_group_id'], "ROOT")
connections[conn_id] = {
'name': row['name'],
'protocol': row['protocol'],
'parameters': {},
'users': [],
'groups': [], # ユーザーグループの格納先
'group': group_path, # 接続グループのパス
'attributes': {}
}
# パラメーターを処理
if row['parameter_name']:
connections[conn_id]['parameters'][row['parameter_name']] = row['parameter_value']
# ユーザーを処理
if row['entity_type'] == 'USER' and row['entity_name'] not in connections[conn_id]['users']:
connections[conn_id]['users'].append(row['entity_name'])
# ユーザーグループを処理
if row['entity_type'] == 'USER_GROUP' and row['entity_name'] not in connections[conn_id]['groups']:
connections[conn_id]['groups'].append(row['entity_name'])
# 属性を処理
if row['attribute_name']:
connections[conn_id]['attributes'][row['attribute_name']] = row['attribute_value']
# リスト形式に変換
connection_list = [conn for conn in connections.values()]
# JSONファイルに出力
with open('export.json', 'w') as json_file:
json.dump(connection_list, json_file, indent=4)
print("エクスポート成功！export.json にデータを書き出しました")
except mysql.connector.Error as err:
print(f"エラー: {err}")
finally:
# カーソルと接続を閉じる
if cursor:
cursor.close()
if conn:
conn.close()
if __name__ == '__main__':
# docker-compose.yml からデータベース構成を取得
db_config = get_db_config_from_compose()
export_to_json(db_config)
スクリプトを実行するには、以下を入力します。
sudo python3 export.pyこれにより、カレントフォルダにexport.jsonというファイルが作成されます。
このexport.jsonファイルには、接続の作成方法によってはシークレット情報 (接続に関する認証情報など) が含まれている可能性があります。このファイルはKeeperボルトに保存して安全に保管してください。
備考
「groups」オブジェクトはユーザーグループを指します。
「group」オブジェクトはコネクショングループの場所を指します。
このデータを別のKCMインスタンスにインポートする際、ターゲットにコネクショングループが存在している場合にのみ、接続は正常にインポートされます。
Last updated