git/gitflow/gitlib>> uart>> 返回
项目作者： hyeoncheon

项目描述 ：
UART is an OAuth2 provider web application for Hyeoncheon project.
高级语言： Go
项目地址: git://github.com/hyeoncheon/uart.git
创建时间： 2017-07-25T16:55:56Z
项目社区：https://github.com/hyeoncheon/uart
开源协议：GNU General Public License v3.0
下载


It’s UART

Build Status
Go Report Card
Maintainability
Test Coverage
Coverage Status
codecov

UART is a management service for Universal Authorization, Authentication,
Roles, and Teams for the Hyeoncheon project.

UART was developed as a successor of my old SiSO project, the original SSO
service for the Hyeoncheon project. (which was developed with Ruby on Rails
on top of well-known Devise, OmniAuth, and other opensource components.)

UART is written in Go (golang) and also is built upon many open source
software modules including
OSIN OAuth2 server library
and powered by open source
Buffalo Go web development eco-system.

Feature

The main features are:

  • Supports sign on/in with social network accounts
    • currently Google, Facebook, and Github accounts are supported.
  • (Future Plan) Email address based local authentication will be added.
    • This will be used as a One-Time-Password option for other authentication.
  • Works as OAuth2 Provider to provide SSO service for family projects.
  • OAuth2 Client App management with optional role based authorization.
    • Role management per each application.
  • Supports standard OAuth2 authorization process.
    • The format of Access Token is JWT(JSON Web Token).
    • Also provide /userinfo API endpoint.
  • Member management and per App roles.

Install

Installation procedure for Ubuntu Linux.

Requirement

To build UART, you need a golang development environment, node.js, and
gobuffalo. Also, a database like MySQL is required to run UART.

The separated document
Requirements to Build/Run UART could be a good reference
if you are not prepared with the environment and need a reference.

Get and Build UART

Clone this repository first.

  1. $ cd $YOUR_WORKSPACE
  2. $ git clone https://github.com/hyeoncheon/uart.git
  3. $ cd uart

Then run the following commands to get related packages.

  1. $ go mod tidy
  2. warning: ignoring symlink /home/sio4/git/hyeoncheon/uart/assets/themes/admin
  3. go: downloading github.com/golang-jwt/jwt v3.2.2+incompatible
  4. go: downloading golang.org/x/oauth2 v0.0.0-20210819190943-2bc19b11175f
  5. <...>
  6. $ yarn
  7. yarn install v1.22.11
  8. [1/4] Resolving packages...
  9. [2/4] Fetching packages...
  10. info fsevents@2.3.2: The platform "linux" is incompatible with this module.
  11. info "fsevents@2.3.2" is an optional dependency and failed compatibility check. Excluding it from installation.
  12. [3/4] Linking dependencies...
  13. [4/4] Building fresh packages...
  14. Done in 10.32s.
  15. $

Prepare database.yml.

  1. $ cp database.yml.dist database.yml
  2. $ $EDIT database.yml

and build the binary.

  1. $ buffalo build
  2. warning: ignoring symlink /home/sio4/git/hyeoncheon/uart/assets/themes/admin
  3. warning: ignoring symlink /home/sio4/git/hyeoncheon/uart/assets/themes/admin
  4. $ ls -lh bin/uart
  5. -rwxrwxr-x 1 sio4 sio4 27M  9월  5 19:13 bin/uart
  6. $ ls -sh public/assets/*.*
  7. 132K public/assets/23f19bb08961f37aaf692ff943823453.eot
  8.  36K public/assets/77206a6bb316fa0aded5083cc57f92b9.eot
  9. 200K public/assets/9bbb245e67a133f6e486d8d2545e14a5.eot
  10. 2.8M public/assets/application.8fe89f055dac055f617c.js
  11. 4.0K public/assets/application.8fe89f055dac055f617c.js.LICENSE.txt
  12. 3.5M public/assets/application.fbee4f0dc0b49d557c81.css
  13. 4.0K public/assets/hyeoncheon.866b2e6102f939c332e1.css
  14.    0 public/assets/hyeoncheon.8fe89f055dac055f617c.js
  15. 4.0K public/assets/manifest.json
  16. $

Install Files

UART has assets to be installed with it. Configure $UART_HOME, generate
SSL keys, then install the binary and all assets into $UART_HOME.

uart.conf and database.yml are provided as a sample. Please modify them
with your conditions.

  1. $ export UART_HOME=/opt/hyeoncheon/uart
  2. $ mkdir -p $UART_HOME/bin
  3. $ scripts/keygen.sh
  4. $ install bin/uart $UART_HOME/bin
  5. $ cp -a files messages $UART_HOME
  6. $ cp supports/uart.service $UART_HOME
  7. $ cp supports/uart.conf.dist $UART_HOME/uart.conf
  8. $ cp database.yml $UART_HOME/database.yml
  9. $ $EDITOR $UART_HOME/uart.conf
  10. $

Assets also include a service description. Register it as a system service.

  1. $ sudo systemctl enable $UART_HOME/uart.service
  2. $ sudo systemctl is-enabled uart
  3. enabled
  4. $

Setup and Run

Mostly done. But UART needs some more preparation to be ready to run.

Configure Database

UART is backed by a database. You need to configure the database before
running it.

(Please make sure if you configure database.yml before running the
commands.)

For development, run the following command. The default environment is
development so we can omit the configuration. The output can be different
for each database engine. The following is for MySQL.

  1. $ buffalo pop create && buffalo pop migrate
  2. v5.3.0
  4. [POP] 2021/09/05 20:01:41 info - create hc_uart_development (hyeoncheon:hyeoncheon@(localhost:3306)/hc_uart_development?collation=utf8mb4_general_ci&multiStatements=true&readTimeout=10s&parseTime=true)
  5. [POP] 2021/09/05 20:01:41 info - created database hc_uart_development
  6. v5.3.0
  8. [POP] 2021/09/05 20:01:42 info - > uart
  9. [POP] 2021/09/05 20:01:42 info - > messaging
  10. [POP] 2021/09/05 20:01:42 info - > docs
  11. [POP] 2021/09/05 20:01:42 info - Successfully applied 3 migrations.
  12. [POP] 2021/09/05 20:01:42 info - 0.9432 seconds
  13. mysqldump: [Warning] Using a password on the command line interface can be insecure.
  14. mysqldump: Error: 'Access denied; you need (at least one of) the PROCESS privilege(s) for this operation' when trying to dump tablespaces
  15. [POP] 2021/09/05 20:01:42 info - dumped schema for hc_uart_development
  16. $

For production mode, you can run the following command. (or you can use the
same command above if you already exported the GO_ENV environment variable.)

  1. $ GO_ENV=production buffalo db create && GO_ENV=production buffalo db migrate
  2. $

Preparing Social Logins

Currently, UART supports login via Google, Facebook, and Github. Before using
them, you need to configure them from their own websites.

Then configure environment variables for them

  1. export GPLUS_KEY="..."
  2. export GPLUS_SECRET="..."
  3. export FACEBOOK_KEY="..."
  4. export FACEBOOK_SECRET="..."
  5. export GITHUB_KEY="..."
  6. export GITHUB_SECRET="..."

Note: UART does not support enabling/disabling selectively for now. You need
to configure them all, otherwise, users will see errors when they click on
unconfigured login link.

Configure Mailgun

The only supported email sending feature, for now, is using www.mailgun.com.
Not sure they still provide Free Plan but please check and configure it.

Run

Wow! Such a long configuration steps! but now we are ready to run!

  1. $ sudo systemctl start uart
  2. $ sudo systemctl status uart
  3. ● uart.service - UART server
  4.    Loaded: loaded (/opt/hyeoncheon/uart/uart.service; linked; vendor preset: enabled)
  5.    Active: active (running) since Wed 2017-11-08 19:03:54 KST; 30min ago
  6.  Main PID: 15264 (uart)
  7.     Tasks: 8
  8.    Memory: 7.7M
  9.       CPU: 352ms
  10.    CGroup: /system.slice/uart.service
  11.            └─15264 /opt/hyeoncheon/uart/uart
  13. <...>
  14. $

Run in Development Mode

Well, we still need a test. The following script is what I used for dev mode
execution.

  1. #!/bin/bash
  2. # environment for uart
  3. # vim: set nowrap syntax=sh:
  5. export GO_ENV='development'
  6. export SESSION_SECRET='fdb3...55b9'
  7. export SESSION_NAME='_uart_session'
  8. export HOST='http://localhost:3000'
  10. export GPLUS_KEY='8730....apps.googleusercontent.com'
  11. export GPLUS_SECRET='c4m1...vwTu'
  12. export GITHUB_KEY='50d4...b4ab'
  13. export GITHUB_SECRET='1cf2...9ba5'
  14. export FACEBOOK_KEY='4231...3146'
  15. export FACEBOOK_SECRET='d4ed...b40f'
  16. #export FACEBOOK_KEY='3201...5981'
  17. #export FACEBOOK_SECRET='6bd6...ee96'
  18. export CF_KEY='b8B2...Hcwv'
  19. export CF_SECRET='Vt7D...lCbT'
  21. export MG_API_KEY='key-78...cf53'
  22. export MG_DOMAIN='mg.example.com'
  23. export MG_URL='https://api.mailgun.net/v3'
  24. export MAIL_SENDER='C-3PO <c3po@example.com>'
  26. buffalo dev

OK, Show Me the Shots

Login Screen

UART Login

Register New App

Each family app should be registered here as the same as we registered UART
on Google, Facebook, and Github. By doing this, users of UART will be able
to login to those family apps.

UART New App

Registered Apps

UART Apps

App Details

Application managers can configure their own application’s OAuth2 settings
and its own roles.

UART App Details

Membership

Users can see their registered applications as a user, Messengers, Teams,
and Credentials. Also, they can request roles for each application. E.g.
A user can be a user of App-A, a manager of App-B, while they all are
basically a user of UART itself.

UART Membership

TODO

  • Team support
  • Email login

Author

Yonghwan SO https://github.com/sio4

Copyright (GNU General Public License v3.0)

Copyright 2016 Yonghwan SO

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; either version 3 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 51
Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA