feat: Move authentication endpoints to Core API (#692)

* feat: Move authentication endpoints from API ui to core API * feat: Test authentication endpoints * feat: Unify some part of Test initialization * wip: Pass did in qr code request * chore: /v1/authentication/qrcode is now a POST and issuerDID is passed in body * feat: Pass did in qr code request as part of the url
0xPolygonID · Jul 22, 2024 · ef62a25 · ef62a25
1 parent 34d9602
commit ef62a25
Show file tree

Hide file tree

Showing 13 changed files with 1,132 additions and 306 deletions.
diff --git a/api/api.yaml b/api/api.yaml
@@ -69,6 +69,93 @@ paths:
                 $ref: '#/components/schemas/Config'
         '500':
           $ref: '#/components/responses/500'
+  #authentication
+  /v1/authentication/sessions/{id}:
+    get:
+      summary: Get Authentication Connection
+      operationId: getAuthenticationConnection
+      description: get authentication connection
+      parameters:
+        - $ref: '#/components/parameters/id'
+      tags:
+        - Auth
+        - Connection
+      security:
+        - basicAuth: [ ]
+      responses:
+        '200':
+          description: ok
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GetAuthenticationConnectionResponse'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '404':
+          $ref: '#/components/responses/404'
+        '500':
+          $ref: '#/components/responses/500'
+
+  # Authentication
+  /v1/{identifier}/authentication/qrcode:
+    post:
+      summary: Get Connection QRCode
+      operationId: authQRCode
+      description: Authentication qrcode
+      tags:
+        - Auth
+      parameters:
+        - $ref: '#/components/parameters/pathIdentifier'
+        - name: type
+          in: query
+          required: false
+          description: >
+            Type:
+              * `link` - (default value) Return a QR code with a link redirection to the raw content. Easier to scan.   
+              * `raw` - Return the raw QR code.
+          schema:
+            type: string
+            enum: [ raw, link ]
+
+      responses:
+        '200':
+          description: ok
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QrCodeLinkShortResponse'
+        '400':
+            $ref: '#/components/responses/400'
+        '500':
+          $ref: '#/components/responses/500'
+
+  /v1/authentication/callback:
+    post:
+      summary: Authentication Callback
+      operationId: authCallback
+      description: Authentication callback
+      tags:
+        - Auth
+      parameters:
+        - $ref: '#/components/parameters/sessionID'
+      requestBody:
+        required: true
+        content:
+          text/plain:
+            schema:
+              type: string
+              example: jwz-token
+      responses:
+        '200':
+          description: ok
+        '400':
+          $ref: '#/components/responses/400'
+        '500':
+          $ref: '#/components/responses/500'
+
+
 #identity:
   /v1/identities:
     post:
@@ -689,6 +776,10 @@ components:
       additionalProperties:
         type: boolean
 
+    UUIDString:
+      type: string
+      x-omitempty: false
+      example: b7144f1c-d54e-4f67-a4f1-f2e7ff1beb07
 
     GenericErrorMessage:
       type: object
@@ -909,6 +1000,34 @@ components:
           type: string
           x-omitempty: false
 
+    AuthenticationConnection:
+      type: object
+      required:
+        - id
+        - userID
+        - issuerID
+        - createdAt
+        - modifiedAt
+      properties:
+        id:
+          $ref: '#/components/schemas/UUIDString'
+        userID:
+          $ref: '#/components/schemas/UUIDString'
+        issuerID:
+          $ref: '#/components/schemas/UUIDString'
+        createdAt:
+          $ref: '#/components/schemas/TimeUTC'
+        modifiedAt:
+          $ref: '#/components/schemas/TimeUTC'
+
+    GetAuthenticationConnectionResponse:
+      type: object
+      required:
+        - connection
+      properties:
+        connection:
+          $ref: '#/components/schemas/AuthenticationConnection'
+
     GetClaimsResponse:
       type: array
       items:
@@ -962,8 +1081,16 @@ components:
           $ref: '#/components/schemas/RefreshService'
 
     QrCodeLinkShortResponse:
-      type: string
-      example: iden3comm://?request_uri=https%3A%2F%2Fissuer-demo.polygonid.me%2Fapi%2Fqr-store%3Fid%3Df780a169-8959-4380-9461-f7200e2ed3f4
+      type: object
+      required:
+        - qrCodeLink
+        - sessionID
+      properties:
+        qrCodeLink:
+          type: string
+          example: iden3comm://?request_uri=https%3A%2F%2Fissuer-demo.polygonid.me%2Fapi%2Fqr-store%3Fid%3Df780a169-8959-4380-9461-f7200e2ed3f4
+        sessionID:
+          $ref: '#/components/schemas/UUIDString'
 
     GetClaimQrCodeResponse:
       type: object
@@ -1009,7 +1136,6 @@ components:
         to:
           type: string
 
-
     CredentialSchema:
       type: object
       required:
@@ -1112,6 +1238,33 @@ components:
       x-omitempty: false
 
   parameters:
+    id:
+      name: id
+      in: path
+      required: true
+      description: |
+        UUID parameter, e.g: 8edd8112-c415-11ed-b036-debe37e1cbd6
+      schema:
+        type: string
+        x-go-type: uuid.UUID
+        x-go-type-import:
+          name: uuid
+          path: github.com/google/uuid
+
+    sessionID:
+      name: sessionID
+      in: query
+      required: true
+      description: |
+        Session ID e.g: 89d298fa-15a6-4a1d-ab13-d1069467eedd
+      schema:
+        type: string
+        x-go-type: uuid.UUID
+        x-go-type-import:
+          name: uuid
+          path: github.com/google/uuid
+
+
     pathIdentifier:
       name: identifier
       in: path

diff --git a/cmd/platform/main.go b/cmd/platform/main.go
@@ -132,13 +132,15 @@ func main() {
 	// repositories initialization
 	identityRepository := repositories.NewIdentity()
 	claimsRepository := repositories.NewClaims()
+	connectionsRepository := repositories.NewConnections()
 	mtRepository := repositories.NewIdentityMerkleTreeRepository()
 	identityStateRepository := repositories.NewIdentityState()
 	revocationRepository := repositories.NewRevocation()
 
 	// services initialization
 	mtService := services.NewIdentityMerkleTrees(mtRepository)
 	qrService := services.NewQrStoreService(cachex)
+	connectionsService := services.NewConnection(connectionsRepository, claimsRepository, storage)
 
 	mediaTypeManager := services.NewMediaTypeManager(
 		map[iden3comm.ProtocolMessage][]string{
@@ -191,7 +193,7 @@ func main() {
 	)
 	api.HandlerFromMux(
 		api.NewStrictHandlerWithOptions(
-			api.NewServer(cfg, identityService, accountService, claimsService, qrService, publisher, packageManager, *networkResolver, serverHealth),
+			api.NewServer(cfg, identityService, accountService, connectionsService, claimsService, qrService, publisher, packageManager, *networkResolver, serverHealth),
 			middlewares(ctx, cfg.HTTPBasicAuth),
 			api.StrictHTTPServerOptions{
 				RequestErrorHandlerFunc:  errors.RequestErrorHandlerFunc,