stytch 6.6.0 → 7.0.1

data/lib/stytch/otps.rb

@@ -101,6 +101,7 @@ module Stytch
       session_jwt: nil,
       session_custom_claims: nil
     )
+      headers = {}
       request = {
         method_id: method_id,
         code: code
@@ -112,7 +113,7 @@ module Stytch
       request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
 
-      post_request('/v1/otps/authenticate', request)
+      post_request('/v1/otps/authenticate', request, headers)
     end
 
     class Sms
@@ -190,6 +191,7 @@ module Stytch
         session_token: nil,
         session_jwt: nil
       )
+        headers = {}
         request = {
           phone_number: phone_number
         }
@@ -200,7 +202,7 @@ module Stytch
         request[:session_token] = session_token unless session_token.nil?
         request[:session_jwt] = session_jwt unless session_jwt.nil?
 
-        post_request('/v1/otps/sms/send', request)
+        post_request('/v1/otps/sms/send', request, headers)
       end
 
       # Send a One-Time Passcode (OTP) to a User using their phone number. If the phone number is not associated with a user already, a user will be created.
@@ -264,6 +266,7 @@ module Stytch
         create_user_as_pending: nil,
         locale: nil
       )
+        headers = {}
         request = {
           phone_number: phone_number
         }
@@ -272,7 +275,7 @@ module Stytch
         request[:create_user_as_pending] = create_user_as_pending unless create_user_as_pending.nil?
         request[:locale] = locale unless locale.nil?
 
-        post_request('/v1/otps/sms/login_or_create', request)
+        post_request('/v1/otps/sms/login_or_create', request, headers)
       end
     end
 
@@ -349,6 +352,7 @@ module Stytch
         session_token: nil,
         session_jwt: nil
       )
+        headers = {}
         request = {
           phone_number: phone_number
         }
@@ -359,7 +363,7 @@ module Stytch
         request[:session_token] = session_token unless session_token.nil?
         request[:session_jwt] = session_jwt unless session_jwt.nil?
 
-        post_request('/v1/otps/whatsapp/send', request)
+        post_request('/v1/otps/whatsapp/send', request, headers)
       end
 
       # Send a one-time passcode (OTP) to a User's WhatsApp using their phone number. If the phone number is not associated with a User already, a User will be created.
@@ -421,6 +425,7 @@ module Stytch
         create_user_as_pending: nil,
         locale: nil
       )
+        headers = {}
         request = {
           phone_number: phone_number
         }
@@ -429,7 +434,7 @@ module Stytch
         request[:create_user_as_pending] = create_user_as_pending unless create_user_as_pending.nil?
         request[:locale] = locale unless locale.nil?
 
-        post_request('/v1/otps/whatsapp/login_or_create', request)
+        post_request('/v1/otps/whatsapp/login_or_create', request, headers)
       end
     end
 
@@ -507,6 +512,7 @@ module Stytch
         login_template_id: nil,
         signup_template_id: nil
       )
+        headers = {}
         request = {
           email: email
         }
@@ -519,7 +525,7 @@ module Stytch
         request[:login_template_id] = login_template_id unless login_template_id.nil?
         request[:signup_template_id] = signup_template_id unless signup_template_id.nil?
 
-        post_request('/v1/otps/email/send', request)
+        post_request('/v1/otps/email/send', request, headers)
       end
 
       # Send a one-time passcode (OTP) to a User using their email. If the email is not associated with a User already, a User will be created.
@@ -586,6 +592,7 @@ module Stytch
         login_template_id: nil,
         signup_template_id: nil
       )
+        headers = {}
         request = {
           email: email
         }
@@ -596,7 +603,7 @@ module Stytch
         request[:login_template_id] = login_template_id unless login_template_id.nil?
         request[:signup_template_id] = signup_template_id unless signup_template_id.nil?
 
-        post_request('/v1/otps/email/login_or_create', request)
+        post_request('/v1/otps/email/login_or_create', request, headers)
       end
     end
   end

data/lib/stytch/passwords.rb

@@ -100,6 +100,7 @@ module Stytch
       untrusted_metadata: nil,
       name: nil
     )
+      headers = {}
       request = {
         email: email,
         password: password
@@ -110,7 +111,7 @@ module Stytch
       request[:untrusted_metadata] = untrusted_metadata unless untrusted_metadata.nil?
       request[:name] = name unless name.nil?
 
-      post_request('/v1/passwords', request)
+      post_request('/v1/passwords', request, headers)
     end
 
     # Authenticate a user with their email address and password. This endpoint verifies that the user has a password currently set, and that the entered password is correct. There are two instances where the endpoint will return a `reset_password` error even if they enter their previous password:
@@ -185,6 +186,7 @@ module Stytch
       session_jwt: nil,
       session_custom_claims: nil
     )
+      headers = {}
       request = {
         email: email,
         password: password
@@ -194,7 +196,7 @@ module Stytch
       request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
 
-      post_request('/v1/passwords/authenticate', request)
+      post_request('/v1/passwords/authenticate', request, headers)
     end
 
     # This API allows you to check whether or not the user’s provided password is valid, and to provide feedback to the user on how to increase the strength of their password.
@@ -248,12 +250,13 @@ module Stytch
       password:,
       email: nil
     )
+      headers = {}
       request = {
         password: password
       }
       request[:email] = email unless email.nil?
 
-      post_request('/v1/passwords/strength_check', request)
+      post_request('/v1/passwords/strength_check', request, headers)
     end
 
     # Adds an existing password to a User's email that doesn't have a password yet. We support migrating users from passwords stored with `bcrypt`, `scrypt`, `argon2`, `MD-5`, `SHA-1`, or `PBKDF2`. This endpoint has a rate limit of 100 requests per second.
@@ -326,6 +329,7 @@ module Stytch
       untrusted_metadata: nil,
       name: nil
     )
+      headers = {}
       request = {
         email: email,
         hash: hash,
@@ -340,7 +344,7 @@ module Stytch
       request[:untrusted_metadata] = untrusted_metadata unless untrusted_metadata.nil?
       request[:name] = name unless name.nil?
 
-      post_request('/v1/passwords/migrate', request)
+      post_request('/v1/passwords/migrate', request, headers)
     end
 
     class Email
@@ -415,6 +419,7 @@ module Stytch
         locale: nil,
         reset_password_template_id: nil
       )
+        headers = {}
         request = {
           email: email
         }
@@ -426,7 +431,7 @@ module Stytch
         request[:locale] = locale unless locale.nil?
         request[:reset_password_template_id] = reset_password_template_id unless reset_password_template_id.nil?
 
-        post_request('/v1/passwords/email/reset/start', request)
+        post_request('/v1/passwords/email/reset/start', request, headers)
       end
 
       # Reset the user’s password and authenticate them. This endpoint checks that the magic link `token` is valid, hasn’t expired, or already been used – and can optionally require additional security settings, such as the IP address and user agent matching the initial reset request.
@@ -515,6 +520,7 @@ module Stytch
         attributes: nil,
         options: nil
       )
+        headers = {}
         request = {
           token: token,
           password: password
@@ -527,7 +533,7 @@ module Stytch
         request[:attributes] = attributes unless attributes.nil?
         request[:options] = options unless options.nil?
 
-        post_request('/v1/passwords/email/reset', request)
+        post_request('/v1/passwords/email/reset', request, headers)
       end
     end
 
@@ -610,6 +616,7 @@ module Stytch
         session_jwt: nil,
         session_custom_claims: nil
       )
+        headers = {}
         request = {
           email: email,
           existing_password: existing_password,
@@ -620,7 +627,7 @@ module Stytch
         request[:session_jwt] = session_jwt unless session_jwt.nil?
         request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
 
-        post_request('/v1/passwords/existing_password/reset', request)
+        post_request('/v1/passwords/existing_password/reset', request, headers)
       end
     end
 
@@ -695,6 +702,7 @@ module Stytch
         session_duration_minutes: nil,
         session_custom_claims: nil
       )
+        headers = {}
         request = {
           password: password
         }
@@ -703,7 +711,7 @@ module Stytch
         request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
         request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
 
-        post_request('/v1/passwords/session/reset', request)
+        post_request('/v1/passwords/session/reset', request, headers)
       end
     end
   end

data/lib/stytch/rbac_local.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative 'errors'
+require_relative 'request_helper'
+
+module StytchB2B
+  class PolicyCache
+    def initialize(rbac_client:)
+      @rbac_client = rbac_client
+      @policy_last_update = 0
+      @cached_policy = nil
+    end
+
+    def reload_policy
+      @cached_policy = @rbac_client.policy['policy']
+      @policy_last_update = Time.now.to_i
+    end
+
+    def get_policy(invalidate: false)
+      reload_policy if invalidate || @cached_policy.nil? || @policy_last_update < Time.now.to_i - 300
+      @cached_policy
+    end
+
+    # Performs an authorization check against the project's policy and a set of roles. If the
+    # check succeeds, this method will return. If the check fails, a PermissionError
+    # will be raised. It's also possible for a TenancyError to be raised if the
+    # subject_org_id does not match the authZ request organization_id.
+    # authorization_check is an object with keys 'action', 'resource_id', and 'organization_id'
+    def perform_authorization_check(
+      subject_roles:,
+      subject_org_id:,
+      authorization_check:
+    )
+      request_org_id = authorization_check['organization_id']
+      raise Stytch::TenancyError.new(subject_org_id, request_org_id) if request_org_id != subject_org_id
+
+      policy = get_policy
+
+      for role in policy['roles']
+        next unless subject_roles.include?(role['role_id'])
+
+        for permission in role['permissions']
+          actions = permission['actions']
+          resource = permission['resource_id']
+          has_matching_action = actions.include?('*') || actions.include?(authorization_check['action'])
+          has_matching_resource = resource == authorization_check['resource_id']
+          if has_matching_action && has_matching_resource
+            # All good
+            return
+          end
+        end
+      end
+
+      # If we get here, we didn't find a matching permission
+      raise Stytch::PermissionError, authorization_check
+    end
+  end
+end

data/lib/stytch/request_helper.rb

@@ -2,29 +2,33 @@
 
 module Stytch
   module RequestHelper
-    def get_request(path)
+    def get_request(path, headers)
       @connection.get(
-        path
+        path,
+        headers
       ).body
     end
 
-    def post_request(path, payload)
+    def post_request(path, payload, headers)
       @connection.post(
         path,
-        payload
+        payload,
+        headers
       ).body
     end
 
-    def put_request(path, payload)
+    def put_request(path, payload, headers)
       @connection.put(
         path,
-        payload
+        payload,
+        headers
       ).body
     end
 
-    def delete_request(path)
+    def delete_request(path, headers)
       @connection.delete(
-        path
+        path,
+        headers
       ).body
     end
 

data/lib/stytch/sessions.rb

@@ -54,11 +54,12 @@ module Stytch
     def get(
       user_id:
     )
+      headers = {}
       query_params = {
         user_id: user_id
       }
       request = request_with_query_params('/v1/sessions', query_params)
-      get_request(request)
+      get_request(request, headers)
     end
 
     # Authenticate a session token and retrieve associated session data. If `session_duration_minutes` is included, update the lifetime of the session to be that many minutes from now. All timestamps are formatted according to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`. This endpoint requires exactly one `session_jwt` or `session_token` as part of the request. If both are included you will receive a `too_many_session_arguments` error.
@@ -108,13 +109,14 @@ module Stytch
       session_jwt: nil,
       session_custom_claims: nil
     )
+      headers = {}
       request = {}
       request[:session_token] = session_token unless session_token.nil?
       request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
       request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
 
-      post_request('/v1/sessions/authenticate', request)
+      post_request('/v1/sessions/authenticate', request, headers)
     end
 
     # Revoke a Session, immediately invalidating all of its session tokens. You can revoke a session in three ways: using its ID, or using one of its session tokens, or one of its JWTs. This endpoint requires exactly one of those to be included in the request. It will return an error if multiple are present.
@@ -143,12 +145,13 @@ module Stytch
       session_token: nil,
       session_jwt: nil
     )
+      headers = {}
       request = {}
       request[:session_id] = session_id unless session_id.nil?
       request[:session_token] = session_token unless session_token.nil?
       request[:session_jwt] = session_jwt unless session_jwt.nil?
 
-      post_request('/v1/sessions/revoke', request)
+      post_request('/v1/sessions/revoke', request, headers)
     end
 
     # Get the JSON Web Key Set (JWKS) for a project.
@@ -180,9 +183,10 @@ module Stytch
     def get_jwks(
       project_id:
     )
+      headers = {}
       query_params = {}
       request = request_with_query_params("/v1/sessions/jwks/#{project_id}", query_params)
-      get_request(request)
+      get_request(request, headers)
     end
 
     # MANUAL(Sessions::authenticate_jwt)(SERVICE_METHOD)
@@ -194,12 +198,15 @@ module Stytch
     # If max_token_age_seconds is set and the JWT was issued (based on the "iat" claim) less than
     # max_token_age_seconds seconds ago, then just verify locally and don't call the API
     # To force remote validation for all tokens, set max_token_age_seconds to 0 or call authenticate()
+    # If max_token_age_seconds is not supplied 300 seconds will be used as the default.
     def authenticate_jwt(
       session_jwt,
       max_token_age_seconds: nil,
       session_duration_minutes: nil,
       session_custom_claims: nil
     )
+      max_token_age_seconds = 300 if max_token_age_seconds.nil?
+
       if max_token_age_seconds == 0
         return authenticate(
           session_jwt: session_jwt,
@@ -208,10 +215,8 @@ module Stytch
         )
       end
 
-      decoded_jwt = authenticate_jwt_local(session_jwt)
-      iat_time = Time.at(decoded_jwt['iat']).to_datetime
-      if iat_time + max_token_age_seconds >= Time.now
-        session = marshal_jwt_into_session(decoded_jwt)
+      session = authenticate_jwt_local(session_jwt)
+      if !session.nil?
         { 'session' => session }
       else
         authenticate(
@@ -232,13 +237,19 @@ module Stytch
     # Parse a JWT and verify the signature locally (without calling /authenticate in the API)
     # Uses the cached value to get the JWK but if it is unavailable, it calls the get_jwks()
     # function to get the JWK
-    # This method never authenticates a JWT directly with the API
-    def authenticate_jwt_local(session_jwt)
+    # If max_token_age_seconds is not supplied 300 seconds will be used as the default.
+    def authenticate_jwt_local(session_jwt, max_token_age_seconds: nil)
+      max_token_age_seconds = 300 if max_token_age_seconds.nil?
+
       issuer = 'stytch.com/' + @project_id
       begin
         decoded_token = JWT.decode session_jwt, nil, true,
                                    { jwks: @jwks_loader, iss: issuer, verify_iss: true, aud: @project_id, verify_aud: true, algorithms: ['RS256'] }
-        decoded_token[0]
+        session = decoded_token[0]
+        iat_time = Time.at(session['iat']).to_datetime
+        return nil unless iat_time + max_token_age_seconds >= Time.now
+
+        session = marshal_jwt_into_session(session)
       rescue JWT::InvalidIssuerError
         raise JWTInvalidIssuerError
       rescue JWT::InvalidAudError
@@ -248,6 +259,8 @@ module Stytch
       rescue JWT::IncorrectAlgorithm
         raise JWTIncorrectAlgorithmError
       end
+
+      session
     end
 
     def marshal_jwt_into_session(jwt)

data/lib/stytch/totps.rb

@@ -56,12 +56,13 @@ module Stytch
       user_id:,
       expiration_minutes: nil
     )
+      headers = {}
       request = {
         user_id: user_id
       }
       request[:expiration_minutes] = expiration_minutes unless expiration_minutes.nil?
 
-      post_request('/v1/totps', request)
+      post_request('/v1/totps', request, headers)
     end
 
     # Authenticate a TOTP code entered by a user.
@@ -133,6 +134,7 @@ module Stytch
       session_jwt: nil,
       session_custom_claims: nil
     )
+      headers = {}
       request = {
         user_id: user_id,
         totp_code: totp_code
@@ -142,7 +144,7 @@ module Stytch
       request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
 
-      post_request('/v1/totps/authenticate', request)
+      post_request('/v1/totps/authenticate', request, headers)
     end
 
     # Retrieve the recovery codes for a TOTP instance tied to a User.
@@ -169,11 +171,12 @@ module Stytch
     def recovery_codes(
       user_id:
     )
+      headers = {}
       request = {
         user_id: user_id
       }
 
-      post_request('/v1/totps/recovery_codes', request)
+      post_request('/v1/totps/recovery_codes', request, headers)
     end
 
     # Authenticate a recovery code for a TOTP instance.
@@ -245,6 +248,7 @@ module Stytch
       session_jwt: nil,
       session_custom_claims: nil
     )
+      headers = {}
       request = {
         user_id: user_id,
         recovery_code: recovery_code
@@ -254,7 +258,7 @@ module Stytch
       request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
 
-      post_request('/v1/totps/recover', request)
+      post_request('/v1/totps/recover', request, headers)
     end
   end
 end

data/lib/stytch/users.rb

@@ -77,6 +77,7 @@ module Stytch
       trusted_metadata: nil,
       untrusted_metadata: nil
     )
+      headers = {}
       request = {}
       request[:email] = email unless email.nil?
       request[:name] = name unless name.nil?
@@ -86,7 +87,7 @@ module Stytch
       request[:trusted_metadata] = trusted_metadata unless trusted_metadata.nil?
       request[:untrusted_metadata] = untrusted_metadata unless untrusted_metadata.nil?
 
-      post_request('/v1/users', request)
+      post_request('/v1/users', request, headers)
     end
 
     # Get information about a specific User.
@@ -114,7 +115,7 @@ module Stytch
     #   An array of phone number objects linked to the User.
     #   The type of this field is list of +PhoneNumber+ (+object+).
     # webauthn_registrations::
-    #   An array that contains a list of all WebAuthn registrations for a given User in the Stytch API.
+    #   An array that contains a list of all Passkey or WebAuthn registrations for a given User in the Stytch API.
     #   The type of this field is list of +WebAuthnRegistration+ (+object+).
     # providers::
     #   An array of OAuth `provider` objects linked to the User.
@@ -149,9 +150,10 @@ module Stytch
     def get(
       user_id:
     )
+      headers = {}
       query_params = {}
       request = request_with_query_params("/v1/users/#{user_id}", query_params)
-      get_request(request)
+      get_request(request, headers)
     end
 
     # Search for Users within your Stytch Project. Submit an empty `query` in the request to return all Users.
@@ -186,12 +188,13 @@ module Stytch
       limit: nil,
       query: nil
     )
+      headers = {}
       request = {}
       request[:cursor] = cursor unless cursor.nil?
       request[:limit] = limit unless limit.nil?
       request[:query] = query unless query.nil?
 
-      post_request('/v1/users/search', request)
+      post_request('/v1/users/search', request, headers)
     end
 
     # Update a User's attributes.
@@ -245,13 +248,14 @@ module Stytch
       trusted_metadata: nil,
       untrusted_metadata: nil
     )
+      headers = {}
       request = {}
       request[:name] = name unless name.nil?
       request[:attributes] = attributes unless attributes.nil?
       request[:trusted_metadata] = trusted_metadata unless trusted_metadata.nil?
       request[:untrusted_metadata] = untrusted_metadata unless untrusted_metadata.nil?
 
-      put_request("/v1/users/#{user_id}", request)
+      put_request("/v1/users/#{user_id}", request, headers)
     end
 
     # Exchange a user's email address or phone number for another.
@@ -292,11 +296,12 @@ module Stytch
       email_address: nil,
       phone_number: nil
     )
+      headers = {}
       request = {}
       request[:email_address] = email_address unless email_address.nil?
       request[:phone_number] = phone_number unless phone_number.nil?
 
-      put_request("/v1/users/#{user_id}/exchange_primary_factor", request)
+      put_request("/v1/users/#{user_id}/exchange_primary_factor", request, headers)
     end
 
     # Delete a User from Stytch.
@@ -320,7 +325,8 @@ module Stytch
     def delete(
       user_id:
     )
-      delete_request("/v1/users/#{user_id}")
+      headers = {}
+      delete_request("/v1/users/#{user_id}", headers)
     end
 
     # Delete an email from a User.
@@ -347,7 +353,8 @@ module Stytch
     def delete_email(
       email_id:
     )
-      delete_request("/v1/users/emails/#{email_id}")
+      headers = {}
+      delete_request("/v1/users/emails/#{email_id}", headers)
     end
 
     # Delete a phone number from a User.
@@ -374,7 +381,8 @@ module Stytch
     def delete_phone_number(
       phone_id:
     )
-      delete_request("/v1/users/phone_numbers/#{phone_id}")
+      headers = {}
+      delete_request("/v1/users/phone_numbers/#{phone_id}", headers)
     end
 
     # Delete a WebAuthn registration from a User.
@@ -401,7 +409,8 @@ module Stytch
     def delete_webauthn_registration(
       webauthn_registration_id:
     )
-      delete_request("/v1/users/webauthn_registrations/#{webauthn_registration_id}")
+      headers = {}
+      delete_request("/v1/users/webauthn_registrations/#{webauthn_registration_id}", headers)
     end
 
     # Delete a biometric registration from a User.
@@ -428,7 +437,8 @@ module Stytch
     def delete_biometric_registration(
       biometric_registration_id:
     )
-      delete_request("/v1/users/biometric_registrations/#{biometric_registration_id}")
+      headers = {}
+      delete_request("/v1/users/biometric_registrations/#{biometric_registration_id}", headers)
     end
 
     # Delete a TOTP from a User.
@@ -455,7 +465,8 @@ module Stytch
     def delete_totp(
       totp_id:
     )
-      delete_request("/v1/users/totps/#{totp_id}")
+      headers = {}
+      delete_request("/v1/users/totps/#{totp_id}", headers)
     end
 
     # Delete a crypto wallet from a User.
@@ -482,7 +493,8 @@ module Stytch
     def delete_crypto_wallet(
       crypto_wallet_id:
     )
-      delete_request("/v1/users/crypto_wallets/#{crypto_wallet_id}")
+      headers = {}
+      delete_request("/v1/users/crypto_wallets/#{crypto_wallet_id}", headers)
     end
 
     # Delete a password from a User.
@@ -509,7 +521,8 @@ module Stytch
     def delete_password(
       password_id:
     )
-      delete_request("/v1/users/passwords/#{password_id}")
+      headers = {}
+      delete_request("/v1/users/passwords/#{password_id}", headers)
     end
 
     # Delete an OAuth registration from a User.
@@ -536,7 +549,8 @@ module Stytch
     def delete_oauth_registration(
       oauth_user_registration_id:
     )
-      delete_request("/v1/users/oauth/#{oauth_user_registration_id}")
+      headers = {}
+      delete_request("/v1/users/oauth/#{oauth_user_registration_id}", headers)
     end
   end
 end