Skip to content

README-ENG.md

Latest commit

 

History

History
163 lines (118 loc) · 5.8 KB

README-ENG.md

File metadata and controls

163 lines (118 loc) · 5.8 KB

sejong-univ-auth

Python versions License Release

sejong-univ-auth image
Sejong University Member Account Authentication

A simple authentication library to verify Sejong University members.

If you're using Python, you can easily implement it as shown below!

Easy to install

Pip: pip install sejong-univ-auth

Direct:

  • git clone https://github.com/iml1111/sejong-univ-auth
  • python setup.py install

Easy to use

>>> from sejong_univ_auth import auth
>>> result = auth(id='16011089', password='<my-password>')
>>> result.is_auth
True

Sejong University provides various web services, all authenticated via a single portal member account.

This library replicates the authentication structure of multiple web services, allowing programmatic use of the results after performing the login.

The endpoint function for using sejong_univ_auth is as follows:

def auth(id: str, password: str, methods: Authenticator)
# id, password: Account information for logging into the Sejong University portal.
# methods: Determines which authentication method to attempt (default=Manual).

Methods

The currently supported authentication methods are:

from sejong_univ_auth import (
    Manual,
    PortalSSOToken,
    DosejongSession,
    MoodlerSession,
    ClassicSession
)

  • PortalSSOToken

    • Authentication method for the Sejong University portal site.

  • DosejongSession

    • Session authentication method for the dosejong site.
    • Additionally retrieves name and major.

  • ClassicSession

    • Session authentication method for the Daeyang Humanities College site.
    • Additional information retrieved:
      • Name
      • Major
      • Year
      • Enrollment status (enrolled/leave of absence/completed)
      • Status of classic reading certification

  • MoodlerSession

    • Session authentication method for the SJULMS site.
    • Additionally retrieves name and major.

  • Manual (default)

    • Executes all implemented methods sequentially in the order of average execution speed.
    • Stops when authentication succeeds or fails due to incorrect ID/password.

To specify a method directly, use the following:

>>> from sejong_univ_auth import PortalSSOToken, DosejongSession, auth
>>> auth(id='<your-id>', password='<your-pw>', methods=PortalSSOToken)
>>> auth(id='<your-id>', password='<your-pw>', methods=DosejongSession)
...
# To execute multiple Authenticators sequentially:
>>> auth(id='<your-id>', password='<your-pw>', methods=[PortalSSOToken, DosejongSession])

If multiple Authenticators are provided as a list (or tuple), they are executed sequentially

If the current method cannot authenticate (e.g., Internal Server Error), it shifts to the next method.

AuthResponse

The result of authentication is returned as a Nametuple:

AuthResponse(
	success=True,
	is_auth=True,
	status_code=200,
	code='success',
	body={
		'name': 'Shin Hee-jae',
		'major': 'Computer Science'
	},
	authenticator='DosejongSession'
)

  • success: Whether the authentication server operated normally

    • Indicates if the server returned valid results for the authentication process.
    • Value: True / False

  • is_auth: Whether authentication succeeded

    • Even with correct ID/password, server errors or updated authentication formats may cause authentication failures.
    • Returns None if the result cannot be determined.
    • Value: True / False / None

  • status_code: HTTP status code of the authentication server

    • Value: int

  • code: Authenticator return code

    • Returns 'success' for successful authentication.
    • Returns specific codes for failures or unknown results.
    • Value: string

  • body: Metadata

    • Contains metadata related to the authentication result, such as:
      • Detailed reasons for authentication failure
      • Additional information like name, student ID, year, enrollment status, etc.
    • Value: dict

  • authenticator: The Authenticator class used for this authentication


Contributors

If you'd like to contribute, please refer to our guidelines. Thank you! 😀

Disclaimer

This open-source library, sejong-univ-auth (hereinafter referred to as “the Software”), is provided under the following terms:

  1. Distributed under MIT License: This Software is distributed under the MIT License.
  2. No Storage or Transmission of Personal Data: The student ID and password entered by users are not stored or transmitted externally. They are used solely for the purpose of determining authentication status.
  3. Unofficial Implementation: This Software is not based on any official API or authorization from Sejong University. It is an independently developed tool that mimics Sejong University’s web authentication procedures. The Software is not affiliated with or endorsed by Sejong University in any way.
  4. Use at Your Own Risk: The Software is provided “as is”, and the use of this Software is entirely at your own risk. The author shall not be held liable for any direct, indirect, incidental, or consequential damages resulting from the use or misuse of this Software.
  5. Free Usage & Compliance Responsibility: The Software is freely available for use by individuals, companies, and organizations. However, users are solely responsible for ensuring that their use of this Software does not violate any third-party terms of service, policies, or applicable laws. Any legal liability arising from such use rests solely with the user.

References