Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merge From Dev #8

Merged
merged 11 commits into from
Sep 27, 2023
Merged

Merge From Dev #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
1d81ba0
feat: decrypt user's email
yujular Sep 1, 2023
df03d91
Merge branch 'OpenTreeHole:main' into dev
yujular Sep 1, 2023
be9e00a
Update .gitignore
yujular Sep 1, 2023
ef01279
feat: add is_shamir_admin fields to the user table
yujular Sep 1, 2023
2ef5f12
feat: shamir admin authentication
yujular Sep 2, 2023
f449802
docs: update swagger docs
yujular Sep 2, 2023
88d435f
chore: update forbidden message
yujular Sep 2, 2023
879b8e1
Merge pull request #6 from yujular/dev
JingYiJun Sep 2, 2023
404ce38
feat: Add email whitelist for registration
yujular Sep 27, 2023
6dcad48
chore: update README.md
yujular Sep 27, 2023
6191861
Merge pull request #7 from yujular/feat-Registerwhitelist
JingYiJun Sep 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 17 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,23 @@ issuing tokens

Environment Variables

| Name | Default | Valid values | Description |
|:-------------------------:|:---------------:|:----------------------------:|:----------------------------------------------------------------------------:|
| MODE | dev | dev, production, test, bench | if dev, log gorm debug sql |
| DB_URL | | | Database DSN, required in "production" mode |
| KONG_URL | | | if STANDALONE is false, required to connect to kong gateway |
| REDIS_URL | | | if not set, use go-cache instead |
| NOTIFICATION_URL | | | if not set, no notification will be sent |
| EMAIL_WHITELIST | | | use ',' to separate emails; if not set, allow all emails |
| EMAIL_SERVER_NO_REPLY_URL | | | required in "production" mode; if not set, unable to send verification email |
| EMAIL_DOMAIN | | | required in "production" mode; if not set, unable to send verification email |
| EMAIL_DEV | [email protected] | | send email if shamir update failed |
| SHAMIR_FEATURE | true | | if enabled, check email shamir encryption when users register and login |
| STANDALONE | false | | if not set, this application not required to set KONG_URL |
| VERIFICATION_CODE_EXPIRES | 10 | integers | register verification code expiration time |
| SITE_NAME | Open Tree Hole | | title prefix of verification email |
| ENABLE_REGISTER_QUESTIONS | false | | if set, user will be set "have not answered questions" when registered |
| Name | Default | Valid values | Description |
|:-------------------------:|:---------------:|:----------------------------:|:------------------------------------------------------------------------------------:|
| MODE | dev | dev, production, test, bench | if dev, log gorm debug sql |
| DB_URL | | | Database DSN, required in "production" mode |
| KONG_URL | | | if STANDALONE is false, required to connect to kong gateway |
| REDIS_URL | | | if not set, use go-cache instead |
| NOTIFICATION_URL | | | if not set, no notification will be sent |
| EMAIL_WHITELIST | | | use ',' to separate emails; if not set, allow all emails |
| VALIDATE_EMAIL_WHITELIST | | | use ',' to separate emails; the emails in it will not be checked for year vs. suffix |
| EMAIL_SERVER_NO_REPLY_URL | | | required in "production" mode; if not set, unable to send verification email |
| EMAIL_DOMAIN | | | required in "production" mode; if not set, unable to send verification email |
| EMAIL_DEV | [email protected] | | send email if shamir update failed |
| SHAMIR_FEATURE | true | | if enabled, check email shamir encryption when users register and login |
| STANDALONE | false | | if not set, this application not required to set KONG_URL |
| VERIFICATION_CODE_EXPIRES | 10 | integers | register verification code expiration time |
| SITE_NAME | Open Tree Hole | | title prefix of verification email |
| ENABLE_REGISTER_QUESTIONS | false | | if set, user will be set "have not answered questions" when registered |

File settings, required in production mode

Expand Down
14 changes: 14 additions & 0 deletions apis/cache.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ var GlobalUploadShamirStatus struct {

func Init() {
InitShamirStatus()
InitUserSharesStatus()

if config.Config.EnableRegisterQuestions {
err := InitQuestions()
Expand Down Expand Up @@ -213,3 +214,16 @@ LOAD_FILES:

return nil
}

var GlobalUserSharesStatus struct {
sync.Mutex
ShamirUsersSharesResponse
}

func InitUserSharesStatus() {
GlobalUserSharesStatus.ShamirUsersSharesResponse = ShamirUsersSharesResponse{
UploadedShares: make(map[int]shamir.Shares, 0),
UploadedSharesIdentityNames: make(map[int][]string, 0),
ShamirUploadReady: make(map[int]bool, 0),
}
}
3 changes: 3 additions & 0 deletions apis/routes.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,7 @@ func RegisterRoutes(app *fiber.App) {
routes.Post("/shamir/key", UploadPublicKey)
routes.Post("/shamir/update", UpdateShamir)
routes.Put("/shamir/refresh", RefreshShamir)
routes.Post("/shamir/decrypt", UploadUserShares)
routes.Get("/shamir/decrypt/:id", GetDecryptedUserEmail)
routes.Get("/shamir/decrypt/status/:id", GetDecryptStatusbyUserID)
}
22 changes: 22 additions & 0 deletions apis/schemas.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,11 @@ type UploadSharesRequest struct {
Shares []UserShare `json:"shares" query:"shares"`
}

type UploadShareRequest struct {
PGPMessageRequest
UserShare
}

type UploadPublicKeyRequest struct {
Data []string `json:"data" validate:"required,len=7"` // all standalone public keys
}
Expand All @@ -233,3 +238,20 @@ type ShamirStatusResponse struct {
FailMessage string `json:"fail_message,omitempty"`
WarningMessage string `json:"warning_message,omitempty"`
}

type ShamirUsersSharesResponse struct {
ShamirUploadReady map[int]bool `json:"shamir_upload_ready"`
UploadedSharesIdentityNames map[int][]string `json:"uploaded_shares_identity_names"`
UploadedShares map[int]shamir.Shares `json:"-"`
}

type ShamirUserSharesResponse struct {
ShamirUploadReady bool `json:"shamir_upload_ready"`
UploadedSharesIdentityNames []string `json:"uploaded_shares_identity_names"`
}

type DecryptedUserEmailResponse struct {
UserID int `json:"user_id"`
UserEmail string `json:"user_email" validate:"required,email"`
IdentityNames []string `json:"identity_names"`
}
Loading