Signup update

api/.env.sample

@@ -1,67 +1,69 @@
-FQDN="localhost"
-API_NAME="Service Name"
-API_PORT="3000"
-API_ALLOW_ORIGIN="http://localhost:3001"
-TOKEN_SECRET="secret"
+FQDN=localhost
+API_NAME=Service Name
+API_PORT=3000
+API_ALLOW_ORIGIN=http://localhost:3001
+TOKEN_SECRET=secret
 TOKEN_EXPIRATION=168h
 API_TOKEN_EXPIRATION=8760h
-PSK=""
-PSK_ALLOW_ORIGIN="http://localhost:3001"
-DOMAINS="example1.net,example2.com"
-LOG_FILE="/var/log/api.log"
-BASIC_AUTH_USER=""
-BASIC_AUTH_PASSWORD=""
-NET_SUBNET=""
-NET_GATEWAY=""
-SIGNUP_WEBHOOK_URL=""
-SIGNUP_WEBHOOK_PSK=""
+PSK=
+PSK_ALLOW_ORIGIN=http://localhost:3001
+DOMAINS=example1.net,example2.com
+LOG_FILE=/var/log/api.log
+BASIC_AUTH_USER=
+BASIC_AUTH_PASSWORD=
+NET_SUBNET=
+NET_GATEWAY=
+SIGNUP_WEBHOOK_URL=
+SIGNUP_WEBHOOK_PSK=
+PREAUTH_URL=
+PREAUTH_PSK=
+PREAUTH_TTL=60m
 
-APP_PORT="3001"
+APP_PORT=3001
 
-DB_HOSTS="db"
-DB_PORT="3306"
-DB_NAME="email"
-DB_USER="email"
-DB_PASSWORD="email"
-DB_ROOT_USER="root"
-DB_ROOT_PASSWORD="root"
+DB_HOSTS=db
+DB_PORT=3306
+DB_NAME=email
+DB_USER=email
+DB_PASSWORD=email
+DB_ROOT_USER=root
+DB_ROOT_PASSWORD=root
 
-REDIS_ADDR="redis:6379"
-REDIS_ADDRS=""
-REDIS_MASTER_NAME=""
-REDIS_USERNAME=""
-REDIS_PASSWORD=""
-REDIS_FAILOVER_USERNAME=""
-REDIS_FAILOVER_PASSWORD=""
-REDIS_TLS_ENABLED="false"
-REDIS_CERT_FILE=""
-REDIS_KEY_FILE=""
-REDIS_CA_CERT_FILE=""
-REDIS_TLS_INSECURE_SKIP_VERIFY="false"
+REDIS_ADDR=redis:6379
+REDIS_ADDRS=
+REDIS_MASTER_NAME=
+REDIS_USERNAME=
+REDIS_PASSWORD=
+REDIS_FAILOVER_USERNAME=
+REDIS_FAILOVER_PASSWORD=
+REDIS_TLS_ENABLED=false
+REDIS_CERT_FILE=
+REDIS_KEY_FILE=
+REDIS_CA_CERT_FILE=
+REDIS_TLS_INSECURE_SKIP_VERIFY=false
 
-SMTP_CLIENT_HOST="smtp.example.net"
-SMTP_CLIENT_PORT="2525"
-SMTP_CLIENT_USER=""
-SMTP_CLIENT_PASSWORD=""
-SMTP_CLIENT_SENDER="from@example.net"
-SMTP_CLIENT_SENDER_NAME="From Name"
+SMTP_CLIENT_HOST=smtp.example.net
+SMTP_CLIENT_PORT=2525
+SMTP_CLIENT_USER=
+SMTP_CLIENT_PASSWORD=
+SMTP_CLIENT_SENDER=from@example.net
+SMTP_CLIENT_SENDER_NAME=From Name
 
 OTP_EXPIRATION=15m
-SUBSCRIPTION_TYPE=""
+SUBSCRIPTION_TYPE=
 MAX_CREDENTIALS=10
 MAX_RECIPIENTS=10
 MAX_DAILY_ALIASES=100
 MAX_DAILY_SEND_REPLY=100
 MAX_SESSIONS=10
-FORWARD_GRACE_PERIOD_DAYS=14
 ACCOUNT_GRACE_PERIOD_DAYS=194
 ID_LIMITER_MAX=5
 ID_LIMITER_EXPIRATION=60m
 
-BACKUP_FILENAME="backup"
-BACKUP_CRON_EXPRESSION="0 0 29 2 1"
+BACKUP_FILENAME=backup
+BACKUP_CRON_EXPRESSION=0 0 29 2 1
 BACKUP_RETENTION_DAYS=7
-GPG_PASSPHRASE=""
-AWS_S3_BUCKET_NAME=""
-AWS_ACCESS_KEY_ID=""
-AWS_SECRET_ACCESS_KEY=""
+GPG_PASSPHRASE=
+AWS_S3_BUCKET_NAME=
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=

api/config/config.go

@@ -23,6 +23,9 @@ type APIConfig struct {
 	BasicAuthPassword  string
 	SignupWebhookURL   string
 	SignupWebhookPSK   string
+	PreauthURL         string
+	PreauthPSK         string
+	PreauthTTL         time.Duration
 }
 
 type DBConfig struct {
@@ -65,7 +68,6 @@ type ServiceConfig struct {
 	MaxDailyAliases        int
 	MaxDailySendReply      int
 	MaxSessions            int
-	ForwardGracePeriodDays int
 	AccountGracePeriodDays int
 	IdLimiterMax           int
 	IdLimiterExpiration    time.Duration
@@ -133,11 +135,6 @@ func New() (Config, error) {
 		return Config{}, err
 	}
 
-	forwardGracePeriodDays, err := strconv.Atoi(os.Getenv("FORWARD_GRACE_PERIOD_DAYS"))
-	if err != nil {
-		return Config{}, err
-	}
-
 	accountGracePeriodDays, err := strconv.Atoi(os.Getenv("ACCOUNT_GRACE_PERIOD_DAYS"))
 	if err != nil {
 		return Config{}, err
@@ -146,6 +143,12 @@ func New() (Config, error) {
 	dbHosts := strings.Split(os.Getenv("DB_HOSTS"), ",")
 	redisAddrs := strings.Split(os.Getenv("REDIS_ADDRESSES"), ",")
 
+	preauthTTLStr := os.Getenv("PREAUTH_TTL")
+	preauthTTL, err := time.ParseDuration(preauthTTLStr)
+	if err != nil {
+		return Config{}, err
+	}
+
 	return Config{
 		API: APIConfig{
 			FQDN:               os.Getenv("FQDN"),
@@ -163,6 +166,9 @@ func New() (Config, error) {
 			BasicAuthPassword:  os.Getenv("BASIC_AUTH_PASSWORD"),
 			SignupWebhookURL:   os.Getenv("SIGNUP_WEBHOOK_URL"),
 			SignupWebhookPSK:   os.Getenv("SIGNUP_WEBHOOK_PSK"),
+			PreauthURL:         os.Getenv("PREAUTH_URL"),
+			PreauthPSK:         os.Getenv("PREAUTH_PSK"),
+			PreauthTTL:         preauthTTL,
 		},
 		DB: DBConfig{
 			Hosts:    dbHosts,
@@ -202,7 +208,6 @@ func New() (Config, error) {
 			MaxDailyAliases:        maxDailyAliases,
 			MaxDailySendReply:      maxDailySendReply,
 			MaxSessions:            maxSessions,
-			ForwardGracePeriodDays: forwardGracePeriodDays,
 			AccountGracePeriodDays: accountGracePeriodDays,
 			IdLimiterMax:           idLimiterMax,
 			IdLimiterExpiration:    idLimiterExpiration,

api/docs/docs.go

@@ -1487,6 +1487,46 @@ const docTemplate = `{
                 }
             }
         },
+        "/rotatepasession": {
+            "put": {
+                "description": "Rotate pre-auth session ID",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "subscription"
+                ],
+                "summary": "Rotate pre-auth session ID",
+                "parameters": [
+                    {
+                        "description": "Rotate pre-auth session request",
+                        "name": "body",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/api.RotatePASessionReq"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/api.SuccessRes"
+                        }
+                    },
+                    "400": {
+                        "description": "Bad Request",
+                        "schema": {
+                            "$ref": "#/definitions/api.ErrorRes"
+                        }
+                    }
+                }
+            }
+        },
         "/settings": {
             "get": {
                 "security": [
@@ -1598,14 +1638,14 @@ const docTemplate = `{
                 }
             }
         },
-        "/subscription/add": {
+        "/sub/session": {
             "post": {
                 "security": [
                     {
                         "ApiKeyAuth": []
                     }
                 ],
-                "description": "Add subscription",
+                "description": "Add pre-auth session",
                 "consumes": [
                     "application/json"
                 ],
@@ -1615,15 +1655,15 @@ const docTemplate = `{
                 "tags": [
                     "subscription"
                 ],
-                "summary": "Add subscription",
+                "summary": "Add pre-auth session",
                 "parameters": [
                     {
-                        "description": "Subscription request",
+                        "description": "Pre-auth session request",
                         "name": "body",
                         "in": "body",
                         "required": true,
                         "schema": {
-                            "$ref": "#/definitions/api.SubscriptionReq"
+                            "$ref": "#/definitions/api.PASessionReq"
                         }
                     }
                 ],
@@ -2360,6 +2400,25 @@ const docTemplate = `{
                 }
             }
         },
+        "api.PASessionReq": {
+            "type": "object",
+            "required": [
+                "id",
+                "preauth_id",
+                "token"
+            ],
+            "properties": {
+                "id": {
+                    "type": "string"
+                },
+                "preauth_id": {
+                    "type": "string"
+                },
+                "token": {
+                    "type": "string"
+                }
+            }
+        },
         "api.RecipientReq": {
             "type": "object",
             "required": [
@@ -2394,6 +2453,17 @@ const docTemplate = `{
                 }
             }
         },
+        "api.RotatePASessionReq": {
+            "type": "object",
+            "required": [
+                "sessionid"
+            ],
+            "properties": {
+                "sessionid": {
+                    "type": "string"
+                }
+            }
+        },
         "api.SettingsReq": {
             "type": "object",
             "required": [
@@ -2459,14 +2529,14 @@ const docTemplate = `{
         "api.SubscriptionReq": {
             "type": "object",
             "required": [
-                "active_until",
-                "id"
+                "id",
+                "subid"
             ],
             "properties": {
-                "active_until": {
+                "id": {
                     "type": "string"
                 },
-                "id": {
+                "subid": {
                     "type": "string"
                 }
             }
@@ -2721,20 +2791,33 @@ const docTemplate = `{
                 "id": {
                     "type": "string"
                 },
-                "type": {
-                    "$ref": "#/definitions/model.SubscriptionType"
+                "outage": {
+                    "type": "boolean"
+                },
+                "status": {
+                    "$ref": "#/definitions/model.SubscriptionStatus"
+                },
+                "tier": {
+                    "type": "string"
+                },
+                "updated_at": {
+                    "type": "string"
                 }
             }
         },
-        "model.SubscriptionType": {
+        "model.SubscriptionStatus": {
             "type": "string",
             "enum": [
-                "Free",
-                "Managed"
+                "active",
+                "grace_period",
+                "limited_access",
+                "pending_delete"
             ],
             "x-enum-varnames": [
-                "Free",
-                "Managed"
+                "Active",
+                "GracePeriod",
+                "LimitedAccess",
+                "PendingDelete"
             ]
         },
         "model.TOTPBackup": {