https://github.com/drschlaubi/telegram-oauth

Telegram login oauth server
https://github.com/drschlaubi/telegram-oauth

login-with-telegram oauth oauth2 oidc openid-connect telegram

Last synced: 3 months ago
JSON representation

Telegram login oauth server

• Host: GitHub
• URL: https://github.com/drschlaubi/telegram-oauth
• Owner: DRSchlaubi
• License: wtfpl
• Created: 2024-01-11T02:29:50.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-12T14:43:51.000Z (5 months ago)
• Last Synced: 2024-09-13T03:05:34.760Z (5 months ago)
• Topics: login-with-telegram, oauth, oauth2, oidc, openid-connect, telegram
• Language: Kotlin
• Homepage:
• Size: 130 KB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# telegram-oauth

Telegram OAuth server for [Telegram Login for Websites](https://core.telegram.org/widgets/login)

This small tool allows you to deploy use Telegrams non-oauth compliant login API with OAuth 2.0 and OIDC compliant

tools like [authentik](https://goauthentik.io/)

# Limitations

These will likely remain, as this is mostly a project for my own use, feel free to copy the code and make your own

if you need more features

- Only a single OAuth client is supported

- Only the `grant_type: authorization_code` and `response_type: code` are supported

- Only the OIDC authorize, token and profile endpoints are supported

# Setup

The application is distributed under the

[ghcr.io/drschlaubi/telegram-oauth](https://github.com/DRSchlaubi/telegram-oauth/pkgs/container/telegram-oauth/165793339?tag=main)

docker image and can be setup the following way

1. Set up a Telegram bot

    1. Message [@BotFather](https://t.me/BotFather) on Telegram

    2. Type `/newbot` and enter a bot Display name and username

    3. use the `/setdomain` command to set the Domain used for this application

2. Setup the application

    1. [Install Docker](https://docs.docker.com/engine/install/)

    2. Download the [docker-compose file](docker-compose.yml)

    3. Create a `.env` file like this and run `docker compose up -d`

      

```

TELEGRAM_TOKEN=

TELEGRAM_BOT=

URL=

JWT_SECRET=

OAUTH_CLIENT_ID=authentik

OAUTH_CLIENT_SECRET=

OAUTH_REDIRECT_URIS=

```

# OAuth endpoints

These are directly compatible with Authentik, just put the URLs in.

Authorize: `/oauth/authorize`

Token: `/oauth/token`

Profile: `/oauth/profile`

## Profile example 

```json5

{

  "sub": "telegram user id",

  "name": "telegram user name",

  "given_name": "telegram first name",

  "family_name": "telegram last name",

  "picture": ""

}

```