Add comment about need for signing auth tokens

Joshua Azemoh · Raphael Akpan
1 parent 86df2e3b
Showing 1 changed file with 3 additions and 1 deletions Show diff stats
lib/generators/scim_rails/templates/initializer.rb
@@ -22,14 +22,16 @@ ScimRails.configure do |config|
   # or throws an error (returning 409 Conflict in accordance with SCIM spec)
   config.scim_user_prevent_update_on_create = false
  
-  # Cryptographic algorithm used for signing the auth token.
+  # Cryptographic algorithm used for signing the auth tokens.
   # It supports all algorithms supported by the jwt gem.
   # See https://github.com/jwt/ruby-jwt#algorithms-and-usage for supported algorithms
   # It is "none" by default, hence generated tokens are unsigned
+  # The tokens do not need to be signed if you only need basic authentication.
   # config.signing_algorithm = "HS256"
  
   # Secret token used to sign authorization tokens
   # It is `nil` by default, hence generated tokens are unsigned
+  # The tokens do not need to be signed if you only need basic authentication.
   # config.signing_secret = SECRET_TOKEN
  
   # Default sort order for pagination is by id. If you
...	...	@@ -22,14 +22,16 @@ ScimRails.configure do \|config\|
22	22	# or throws an error (returning 409 Conflict in accordance with SCIM spec)
23	23	config.scim_user_prevent_update_on_create = false
24	24
25		- # Cryptographic algorithm used for signing the auth token.
	25	+ # Cryptographic algorithm used for signing the auth tokens.
26	26	# It supports all algorithms supported by the jwt gem.
27	27	# See https://github.com/jwt/ruby-jwt#algorithms-and-usage for supported algorithms
28	28	# It is "none" by default, hence generated tokens are unsigned
	29	+ # The tokens do not need to be signed if you only need basic authentication.
29	30	# config.signing_algorithm = "HS256"
30	31
31	32	# Secret token used to sign authorization tokens
32	33	# It is `nil` by default, hence generated tokens are unsigned
	34	+ # The tokens do not need to be signed if you only need basic authentication.
33	35	# config.signing_secret = SECRET_TOKEN
34	36
35	37	# Default sort order for pagination is by id. If you
...	...