Skip to main content

Kyoto University SSO session bootstrapper for KULASIS / KULMS / MyKULINE / PandA.

Project description

kuauth

PyPI version License: MIT CI codecov CodeQL Live integration Context7 Indexed Context7 llms.txt

京都大学の SSO (KULASIS / KULMS / MyKULINE / PandA) を単一のセッションで叩くための Python クライアントです。初回のサービスアクセス時に必要な IdP ウォークが遅延実行され、それ以降は通常の HTTP クライアントとして使えます。

インストール

uv add kuauth

Quickstart

from kuauth import KyotoUAuth, KULASIS, KULMS, MyKULINE, PandA

auth = KyotoUAuth(
    username="a0XXXXXX",
    password="your-password",
    # onetime_password="424242",             # 手元の 6 桁コードを 1 回だけ使う
    otp_callback=lambda: input("OTP: "),     # 対話的スクリプト
    # totp_secret="JBSWY3DPEHPK3PXP",        # cron / CI など無人実行
)

print(KULASIS(auth).get("/student/la/top").text)            # 教務 (Shift_JIS 自動デコード)
print(KULMS(auth).get("/portal").text)                      # Sakai LMS
print(MyKULINE(auth).get("/opac/opac_search/").text)        # 図書館 OPAC
print(PandA(auth).get("/portal").text)                      # 旧 LMS (ECS CAS)

auth.close()

Cookies

特定サービス向けの認証済みセッション cookie だけ欲しい場合は service.cookies() を使います。必要に応じて対象サービスのセッションを確立したうえで、そのサービスに送られる cookie を httpx.Cookies として返します。返り値は共有 cookie jar そのものではなく、対象サービス向けに切り出したコピーです。

from kuauth import KyotoUAuth, KULASIS

auth = KyotoUAuth(
    username="a0XXXXXX",
    password="your-password",
    totp_secret="JBSWY3DPEHPK3PXP",
)

cookies = KULASIS(auth).cookies()
print(dict(cookies.items()))

auth.close()

認証方法

OTP が必要かどうかは、アクセスする SP によって変わります。

Service Base URL 認証経路 OTP
KULASIS https://www.k.kyoto-u.ac.jp auth.iimc (SimpleSAMLphp) 必要
KULMS https://lms.gakusei.kyoto-u.ac.jp auth.iimc (SimpleSAMLphp) 必要
MyKULINE https://kuline.kulib.kyoto-u.ac.jp authidp1 (Java Shib IdP) 不要
PandA https://panda.ecs.kyoto-u.ac.jp ECS CAS 不要

OTP は実際に OTP フォームに到達した時点で初めて解決されます。つまり、MyKULINE や PandA しか使わないスクリプトでは totp_secret 等の指定は省略できます。KULASIS / KULMS を叩く場合のみ、下記のいずれかを渡してください。

引数 用途
onetime_password="424242" 手元の 6 桁コードを 1 回だけ使う
otp_callback=lambda: input("OTP: ") 対話的スクリプト
totp_secret="JBSWY3DPEHPK3PXP" cron / CI など無人実行

TOTP シークレットは 京大の多要素認証マニュアル に従って認証アプリを登録する際の QR に埋め込まれた otpauth://totp/...?secret=XXXX&...secret パラメータです。登録後は QR が再表示されないので、登録画面で控えておくか、一度アプリを解除して再登録してください。

KUMOI (Microsoft 365) はテナント admin consent が必要なため、スコープ外です。

個別エンドポイントのラッパメソッドは持たない設計です。HAR ファイルから URL とフォーム構造を特定すれば、KULASIS(auth).post(...) などを使って呼び出し側で任意のページを叩けます。

テスト

uv run pytest tests/unit -q      # ネットワーク不要
uv run pytest tests/replay -q    # respx でモックした E2E

実 IdP と実サービスを叩く統合テストは KUAUTH_LIVE=1 を指定しない限り、すべてスキップされます。実行するには以下の環境変数をセットしてください。

KUAUTH_TOTP_SECRET は KULASIS / KULMS のテストに必要です。省略すると auth_with_totp を使うテストだけがスキップされます (MyKULINE / PandA は走ります)。

# bash / Git Bash
KUAUTH_LIVE=1 \
  KUAUTH_USERNAME=a0XXXXXX \
  KUAUTH_PASSWORD=... \
  KUAUTH_TOTP_SECRET=JBSWY3DPEHPK3PXP \
  uv run pytest tests/integration -q
# PowerShell
$env:KUAUTH_LIVE="1"
$env:KUAUTH_USERNAME="a0XXXXXX"
$env:KUAUTH_PASSWORD="..."
$env:KUAUTH_TOTP_SECRET="JBSWY3DPEHPK3PXP"
uv run pytest tests/integration -q

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kuauth-0.3.4.tar.gz (105.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kuauth-0.3.4-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

Details for the file kuauth-0.3.4.tar.gz.

File metadata

  • Download URL: kuauth-0.3.4.tar.gz
  • Upload date:
  • Size: 105.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for kuauth-0.3.4.tar.gz
Algorithm Hash digest
SHA256 0037e77bd5be9d49371c8b0e8b97b987fb9616ce05587447066c969bd6d62610
MD5 e04ecda64a0ec56b298eceff39055a3d
BLAKE2b-256 f98dd79193cf21807f096c6ce7332c8d3d54d31cbd23a850332cdfddcead3b30

See more details on using hashes here.

Provenance

The following attestation bundles were made for kuauth-0.3.4.tar.gz:

Publisher: release.yml on youseiushida/kuauth

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kuauth-0.3.4-py3-none-any.whl.

File metadata

  • Download URL: kuauth-0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 18.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for kuauth-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 28302228f082e3ef6ace0f30ad4e2a1459b17c76adbfa4af0875ea6e788bf258
MD5 2cf4fc9fec527170d5fde2eded2fa92d
BLAKE2b-256 3b56f17f56b54b46fb89d9b6ce18163199c2f7c7221405e55319733214e983e0

See more details on using hashes here.

Provenance

The following attestation bundles were made for kuauth-0.3.4-py3-none-any.whl:

Publisher: release.yml on youseiushida/kuauth

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page