socket.yml

name: two-factor-auth
description: Two-factor authentication socket
version: 0.0.5
keywords:
  - two-factor
  - one-time
  - password
  - passcode
  - totp
classes:
  user:
    - name: two_factor_details
      type: text
    - name: two_factor_enabled
      type: boolean
      filter_index: true
endpoints:
  setup-two-factor:
    description: Setup two-factor authentication for logged in user
    inputs:
      properties:
        username:
          type: string
          description: User email
          example: you@domain.com
        token:
          type: string
          description: User token
          example: cb21fac8c7dda8fcd0129b0adb0254dea5c8e
    outputs:
      success:
        description: Success
        required:
          - message
        properties:
          message:
            description: Success data
            examples:
              - |
                {
                  message: "Verify OTP",
                  tempSecret: "LBGDOZBIKARWIRZI",
                  otpURL: "otpauth://totp/SecretKey?secret=LB",
                  dataURL: "data:image/png;base64,iVBORw0KGgoAAAANS"
                }
      fail:
        exit_code: 400
        description: Failed
        required:
          - message
        properties:
          message:
            description: Error message
            examples:
              - |
                {
                  "message": "Failed to setup two-factor authentication on user account"
                }
  verify-token:
    description: >-
      Verifies token before enabling two-factor authentication to prevent
      locking user
    inputs:
      properties:
        username:
          type: string
          description: User email
          example: you@domain.com
        token:
          type: string
          description: User token
          example: cb21fac8c7dda8fcd0129b0adb0254dea5c8e
        two_factor_token:
          type: string
          description: One-time passcode for user
          example: '897900'
    outputs:
      success:
        description: Success
        required:
          - message
        properties:
          message:
            description: Success data
            examples:
              - |
                {
                  message: "Two-factor authentication enabled"
                }
      fail:
        exit_code: 400
        description: Failed
        required:
          - message
        properties:
          message:
            description: Error message
            examples:
              - |
                {
                  "message": "Invalid two-factor token, verification failed"
                }
  login:
    description: 'Login endpoint supports both, normal auth and two-factor authentication'
    inputs:
      properties:
        username:
          type: string
          description: User email
          example: you@domain.com
        password:
          type: string
          description: User password
          example: user-password
        two_factor_token:
          type: string
          description: One-time passcode for user
          example: '897900'
    outputs:
      success:
        description: Success
        required:
          - message
        properties:
          message:
            description: Success data
            examples:
              - |
                {
                  token: "cb21ff98ac8c7dda8fcd01",
                  username: "you@domain.com"
                }
      fail:
        exit_code: 400
        description: Failed
        required:
          - message
        properties:
          message:
            description: Error message
            examples:
              - |
                {
                  message: "Please enter two-factor token"
                }
  disable-two-factor:
    description: Disable two-factor authentication for user
    inputs:
      properties:
        username:
          type: string
          description: User email
          example: you@domain.com
        token:
          type: string
          description: User token
          example: cb21fac8c7dda8fcd0129b0adb0254dea5c8e
        two_factor_token:
          type: string
          description: One-time passcode for user
          example: '897900'
    outputs:
      success:
        description: Success
        required:
          - message
        properties:
          message:
            description: Success data
            examples:
              - |
                {
                  message: "Two-factor authentication disabled"
                }
      fail:
        exit_code: 400
        description: Failed
        required:
          - message
        properties:
          message:
            description: Error message
            examples:
              - |
                {
                  "message": "Given credentials does not match any user account"
                }
  check-two-factor:
    description: Checks if two factor authentication is enabled on user account
    inputs:
      properties:
        username:
          type: string
          description: User email
          example: you@domain.com
      token:
        type: string
        description: User token
        example: cb21fac8c7dda8fcd0129b0adb0254dea5c8e
    outputs:
      success:
        description: Success
        required:
          - message
        properties:
          message:
            description: Success data
            examples:
              - |
                {
                  message: "Two-factor authentication is enabled on user account",
                  is_two_factor: true
                }
      fail:
        exit_code: 400
        description: Failed
        required:
          - message
        properties:
          message:
            description: Error message
            examples:
              - |
                {
                  message: "Two-factor authentication is not enabled on user account",
                  is_two_factor: false
                }