robust_server_socket 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37064c5a03f119d17df76cb2eba1bd14b91d0cb4732f0d4aa29505614131966f
-  data.tar.gz: b18b44079588faf7a38979174971f928f50eb5c1535f0fc6ade2980ace6ed771
+  metadata.gz: 5ab7c243900b7f5a64995876c99501a830670a1dfddc217c5f49ec2699fac503
+  data.tar.gz: 5c7552b5d17afae304cf186b5025b874a6a04b7afe80cd4c47092478a809689a
 SHA512:
-  metadata.gz: 91e42034b36683bfb0d7c481e9f9ef0e3acfae64d43214c0631bf797dbcbd94756e57288cf9a23f2cff2fccea307f019f0ffa93bfea5f86df2f4e751b171fd87
-  data.tar.gz: cd15f31a2c698f54684912f1ba3a1b87e8cca074ae0e0967b3374e861484d8bd45a546df35f42781beb651f4505d439ffbff643c3bb6db662fbe4666a87a7a83
+  metadata.gz: 9faa202465b8c25c0ec07fee1a4ea9f18531488a1f6f6eb4717bb29e5424ddb8266912e1eaf7dda84c366ed276beede43b740eadb5fdde9a146f14b3b99b601b
+  data.tar.gz: 410d43f438f999b0474d939319c65647ecc617c7a3313be38d0b7eb567cc20bc64d3f766bdca60089131c55fbd868849f3ba1f1cddf04bb4623f51e50c813f1c

data/lib/robust_server_socket.rb

@@ -17,6 +17,5 @@ module RobustServerSocket
 
     require_relative 'robust_server_socket/rate_limiter'
     require_relative 'robust_server_socket/client_token'
-    require_relative 'robust_server_socket/private_message'
   end
 end

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RobustServerSocket
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: robust_server_socket
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - tee_zed
@@ -75,7 +75,6 @@ files:
 - ".rspec"
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
-- README.md
 - Rakefile
 - lib/robust_server_socket.rb
 - lib/robust_server_socket/client_token.rb

data/README.md

@@ -1,59 +0,0 @@
-# RobustServerSocket
-
-Gem for in-service Authorization for using with RobustClientSocket
-
-## Security
-
-- RSA-2048 key pair is used for authorization.
-- Authorized client names are stored in token and config
-- Token is staleable
-- Token if one-time use only
-- Blacklist for tokens in redis
-
-## Usage
-
-'config/initializers/robust_server_socket.rb'
-
-```ruby
-RobustServerSocket.configure do |c|
-  c.private_key = '-----PRIVATE KEY-----[...]' # private key of the service, from pair of keys by RobustServerSocket
-  c.token_expiration_time = 10.minutes # time in seconds for token expiration
-  c.allowed_services = %w(core) # list of services allowed to use this service, must be same as service name in keychain in RobustClientSocket
-  # so if we have 
-  # RobustClientSocket.configure do |c|
-  # c.keychain = {
-  #   core: { <<< service name
-  #           base_uri: 'https://core.payrent.com',
-  #           public_key: '-----BEGIN PUBLIC KEY-----[...]'
-  #   },
-  # we should add 'core' to allowed_services
-  c.redis_url = 'redis://localhost:6379' # redis url for storing tokens
-  c.redis_pass = 'password' # redis password
-  
-  # Optional: Rate Limiting (disabled by default)
-  c.rate_limit_enabled = true # enable rate limiting per client
-  c.rate_limit_max_requests = 100 # maximum requests per window (default: 100)
-  c.rate_limit_window_seconds = 60 # time window in seconds (default: 60)
-end
-  
-RobustServerSocket.load!
-```
-
-and then
-
-```ruby
-token = RobustServerSocket::ClientToken.new(token) # token - is a Bearer from secure-token header
-token.valid? #Boolean  check if token is not expired and client is allowed to use this service, main authorization check
-token.client #String  name of the client
-
-RobustServerSocket::ClientToken.validate!(token) # shortcut for token.valid? and raises specific errors
-```
-## Errors
-
-`RobustServerSocket::ClientToken::UnauthorizedClient` - client is not allowed to use this service you should add it to allowed_services
-`RobustServerSocket::ClientToken::UsedToken` - token is already used
-`RobustServerSocket::ClientToken::StaleToken` - token is stale over the expiration time
-`RobustServerSocket::ClientToken::InvalidToken` - token decryption failed
-`RobustServerSocket::ClientToken::RateLimitExceeded` - client exceeded rate limit (only when rate limiting is enabled)
-
-