Commit 1d6b449

mo <mo@mokhan.ca>
2018-10-28 21:16:09
document the client credentials grant
1 parent 00709f0
doc/_includes/get-well-known-oauth-authorization-server.html
@@ -34,7 +34,7 @@ Referrer-Policy: strict-origin-when-cross-origin
 Content-Type: application/json; charset=utf-8
 Etag: W/"7f1eee6ebfc3008c58d630548ed1707c"
 Cache-Control: max-age=0, private, must-revalidate
-X-Request-Id: a8ead785-8586-4d59-8bbe-8ec7c38445bf
+X-Request-Id: a0b599d8-db1f-4674-9b3c-c029b7dd6e3d
 Transfer-Encoding: chunked
 ```
 
doc/_includes/oauth-tokens-authorization-code.html
@@ -6,11 +6,11 @@ Example curl request:
 ```bash
 $ curl http://localhost:5000/oauth/tokens \
   -X POST \
-  -d '{"grant_type":"authorization_code","code":"53RFPrXJkRGCcC5yqKfJrhGx"}' \
+  -d '{"grant_type":"authorization_code","code":"LjaokKL42vfDj1q6XR2GthZF"}' \
   -H "Accept: application/json" \
   -H "Content-Type: application/json" \
   -H "User-Agent: net/hippie 0.1.9" \
-  -H "Authorization: Basic NzQwY2FjNmYtNWMxZC00YTBmLTkyYmEtNTFhMGI0OGVjYjgxOldZY3VEOW9laGY5dWRMdDhubXIzSGdRag==" \
+  -H "Authorization: Basic MDViMTg3NjItYmYzYi00YjVmLWExYjEtNzlhMWFhNGM0NmVhOmpVbm11dlMyNlgyVUZYUGdpbmNzR25jYQ==" \
   -H "Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3"
 ```
 Request Headers:
@@ -19,7 +19,7 @@ Request Headers:
 Accept: application/json
 Content-Type: application/json
 User-Agent: net/hippie 0.1.9
-Authorization: Basic NzQwY2FjNmYtNWMxZC00YTBmLTkyYmEtNTFhMGI0OGVjYjgxOldZY3VEOW9laGY5dWRMdDhubXIzSGdRag==
+Authorization: Basic MDViMTg3NjItYmYzYi00YjVmLWExYjEtNzlhMWFhNGM0NmVhOmpVbm11dlMyNlgyVUZYUGdpbmNzR25jYQ==
 Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3
 ```
 
@@ -28,7 +28,7 @@ Request Body:
 ```json
 {
   "grant_type": "authorization_code",
-  "code": "53RFPrXJkRGCcC5yqKfJrhGx"
+  "code": "LjaokKL42vfDj1q6XR2GthZF"
 }
 ```
 
@@ -44,8 +44,8 @@ Referrer-Policy: strict-origin-when-cross-origin
 Cache-Control: private, no-store
 Pragma: no-cache
 Content-Type: application/json; charset=utf-8
-Etag: W/"e285a69c08c19a459453f718028a5f5e"
-X-Request-Id: 86e14b3b-0897-4657-8669-b311ac950caa
+Etag: W/"e4cfba55350ff91e553441ad574ab54c"
+X-Request-Id: a126b4e0-e660-48d4-b2e5-9650e20c60c7
 Transfer-Encoding: chunked
 ```
 
@@ -53,10 +53,10 @@ Transfer-Encoding: chunked
 Response Body:
 ```json
 {
-  "access_token": "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE1NDA3NjQ3MzEsImlhdCI6MTU0MDc2MTEzMSwiaXNzIjoiaHR0cDovL3Byb29mLnRlc3QvbWV0YWRhdGEiLCJuYmYiOjE1NDA3NjExMzEsImF1ZCI6Ijc0MGNhYzZmLTVjMWQtNGEwZi05MmJhLTUxYTBiNDhlY2I4MSIsImp0aSI6IjZkZTRkODA0LTdmODItNDlmYy1hYTAxLTA1OTIxMzRmMDQ0NiIsInN1YiI6ImZiMTZkMDUwLWRjZWUtNDcxNS05MjViLWRjMTY5YmE0OGY5YiIsInRva2VuX3R5cGUiOiJhY2Nlc3MifQ.dqjf455ehqQ3n_FskTlngYlRmVQZ8UdNbpoybnwVzYc6JSwI_8kFrS2zCNxexn0jqpMmzoTyuVvzqkR1-6FUZmbdFBnR5edEaGeG06FmrWqCQczHb8k4pIT_dK3IjaZdgbmW_YwprmIb5CUAp__dRw1c8AgO-AI-ScG5B6vG7_RnTXxVMk0yMrsD8V7cZQEXRZKH-4WW5TtPDNDaq3t2baHfM6cTgCFP-J0_7lTOYXgyQucPfmHa3-u7rHHRMgt8QdgV9qf_7xpXjJEIyE1KKxPj-RGWjlOqAtwwrpsN8ZhApIXi1ItriJxApq7or_OWzLoA1AhtmYBLljnH3_gHPA",
+  "access_token": "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE1NDA3NjQ5MjEsImlhdCI6MTU0MDc2MTMyMSwiaXNzIjoiaHR0cDovL3Byb29mLnRlc3QvbWV0YWRhdGEiLCJuYmYiOjE1NDA3NjEzMjEsImF1ZCI6IjA1YjE4NzYyLWJmM2ItNGI1Zi1hMWIxLTc5YTFhYTRjNDZlYSIsImp0aSI6ImYwYWUyOTM0LTBjNjgtNDc4Yy05YWFjLTIwMGY4Yzk5ODA2NCIsInN1YiI6IjZiYmNkYjI2LTBjYzItNGM4NS1hMjZmLTMzZGY0NzIwNjllMSIsInRva2VuX3R5cGUiOiJhY2Nlc3MifQ.bxF3_HhvG8MLVCPDe2c9Kg0vbCweirSHvWbV8Yy044NhlkWFayh7quwzMrpFYGBcAhHgXTIYsygHSGPiJBBpnJL4nHRmDjuwmF-VB0C1GTmnPcPltbTGPW8FkFeTo50TTr_G7-eWJ0uGrbyJn9vLG8jlVgdW2eG-_Amidei9mz9Z4ns62v1-IDHn7tVRzU60PHbu2kRTRShinUunDZw6-yM6cqoj_sXfSmofBwAfp-d4UVhbEUNGeMyhYJrbLdSB-8YI_Xvjs7xwE1BCxrUR0JJ10ltPjnXMTOkhKEDYuXvbHZ_wYVqc4skVRBVayeC3KX1tF2r941AhbMdr8WBGLg",
   "token_type": "Bearer",
   "expires_in": 3600,
-  "refresh_token": "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE1NDA4NDc1MzEsImlhdCI6MTU0MDc2MTEzMSwiaXNzIjoiaHR0cDovL3Byb29mLnRlc3QvbWV0YWRhdGEiLCJuYmYiOjE1NDA3NjExMzEsImF1ZCI6Ijc0MGNhYzZmLTVjMWQtNGEwZi05MmJhLTUxYTBiNDhlY2I4MSIsImp0aSI6Ijk3YjlkZWJkLTM3YjAtNDYyOC05NWU4LTdjMWZkMDI2OTBmMCIsInN1YiI6ImZiMTZkMDUwLWRjZWUtNDcxNS05MjViLWRjMTY5YmE0OGY5YiIsInRva2VuX3R5cGUiOiJyZWZyZXNoIn0.NSlgUB6dSWrbLsHtf6SEACw3MqfhBzjK-5kZRgNt8K0STBrNd_3ecT1sZmqyVwfsC_qD1h2Aw2fwU8ESnb4Gr69zzI8ahezDHg2CjYPvrToYVABv8hul_z0-qIPEC8mTh2NJQfheeAvebqq7GufeDZSjGds_sLWrDxfzCrcgdq2cTapan5lzXyjnYzYyUa6uB4Ppw2wpp9oVXEzdHMWT9MKRh88oiZnSY_L_vzbA2ZlxFkZCaEYpDTeTGVAvfC7n3iEYmHJMj0I8sLIjV5HXfZhiEtnO7-4ZZtdPMBqPHjM4oGqsOpVKETvEF4J8dlYUNQ3UcJtcO7LxBXvp2D7jdQ"
+  "refresh_token": "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE1NDA4NDc3MjEsImlhdCI6MTU0MDc2MTMyMSwiaXNzIjoiaHR0cDovL3Byb29mLnRlc3QvbWV0YWRhdGEiLCJuYmYiOjE1NDA3NjEzMjEsImF1ZCI6IjA1YjE4NzYyLWJmM2ItNGI1Zi1hMWIxLTc5YTFhYTRjNDZlYSIsImp0aSI6IjM1MzM1MzI2LTYzZWYtNDgzNC05Y2QwLTA1MDZkYTYyMGQ2NSIsInN1YiI6IjZiYmNkYjI2LTBjYzItNGM4NS1hMjZmLTMzZGY0NzIwNjllMSIsInRva2VuX3R5cGUiOiJyZWZyZXNoIn0.qqEqm_luiIynAWVnhIAyiODA7nu4IUcPsyvU7jJijVV7MmUwfykk9ehkUQyz9PuGaWaQwRcyY5apiRpzuNwKLJDlbaGTX_VkAtaIsHwP45efy3UcmiuDb-nbjGuWvDLDkGz88TOWgZbOckpvyDOQnP2qeNDMqeUo6fywn9zwsYW0hs3w6YoXwZShhLHAFl0VDu5flq0su5hGDO-vldNpTOaDWFBl5hnXbBf-cf32ag5eMVByUOZ8-WOLZV75PvZWBzarrYYlKQLAI-HTpQOjtcxvISFw3uhgCfqgQ7owP0up5Q8lW7Exh2chB76LXGICyq51IRMx7kkkY5Nc7GdJFw"
 }
 ```
 
doc/_includes/oauth-tokens-client-credentials.html
@@ -0,0 +1,61 @@
+
+#### POST http://localhost:5000/oauth/tokens
+
+Example curl request:
+
+```bash
+$ curl http://localhost:5000/oauth/tokens \
+  -X POST \
+  -d '{"grant_type":"client_credentials"}' \
+  -H "Accept: application/json" \
+  -H "Content-Type: application/json" \
+  -H "User-Agent: net/hippie 0.1.9" \
+  -H "Authorization: Basic OGVkMzljOTYtNzk0MS00YWQyLWI0MzUtNDdlNTYwNGU5YWMxOllBZXlGVzZESEN1OFlRU2hjS0Z3V1gzcQ==" \
+  -H "Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3"
+```
+Request Headers:
+
+```text
+Accept: application/json
+Content-Type: application/json
+User-Agent: net/hippie 0.1.9
+Authorization: Basic OGVkMzljOTYtNzk0MS00YWQyLWI0MzUtNDdlNTYwNGU5YWMxOllBZXlGVzZESEN1OFlRU2hjS0Z3V1gzcQ==
+Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+```
+
+
+Request Body:
+```json
+{
+  "grant_type": "client_credentials"
+}
+```
+
+Response Headers:
+
+```text
+X-Frame-Options: SAMEORIGIN
+X-Xss-Protection: 1; mode=block
+X-Content-Type-Options: nosniff
+X-Download-Options: noopen
+X-Permitted-Cross-Domain-Policies: none
+Referrer-Policy: strict-origin-when-cross-origin
+Cache-Control: private, no-store
+Pragma: no-cache
+Content-Type: application/json; charset=utf-8
+Etag: W/"741de2d275c50f8edb7b319c01c600dc"
+X-Request-Id: 411d96b6-5388-4743-bb9f-eb009c8818c7
+Transfer-Encoding: chunked
+```
+
+
+Response Body:
+```json
+{
+  "access_token": "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE1NDA3NjQ5MjIsImlhdCI6MTU0MDc2MTMyMiwiaXNzIjoiaHR0cDovL3Byb29mLnRlc3QvbWV0YWRhdGEiLCJuYmYiOjE1NDA3NjEzMjIsImF1ZCI6IjhlZDM5Yzk2LTc5NDEtNGFkMi1iNDM1LTQ3ZTU2MDRlOWFjMSIsImp0aSI6ImVmMjExMmZhLTgxNzctNDZlMi05ZDhkLWRhMGY5YmIzYzBhNCIsInN1YiI6IjhlZDM5Yzk2LTc5NDEtNGFkMi1iNDM1LTQ3ZTU2MDRlOWFjMSIsInRva2VuX3R5cGUiOiJhY2Nlc3MifQ.KeNZMVSr0iIJLBzwf1Q653UJTSO9RuvZ8RutZVtZPqEgt9N3MZJzFleHc88FblN1Wv7sIfTtaCInc666tRivNa2bBaS4W7y-3L4pVFmsvFczeARYOhWdRMHCGk9BvQwFjfpKLjGmu17GascqSEGAnCRPbhUbHmhBoqsCbW-iQ1A5MOusDmXSQ53GNx1gamdQkcDrVJZveFXQpW5FQcEkpFgzMxTzgUmxQNowNbNWauRfQRkROZKkabuME8sQrBGFZ0bl7rVS_MyV1Ptmdg_FhpQ7ctWTLhm0WC6ZDNB1pidrXsePjxj8ZFzP5uniu47qg5_3Mbju-NGakwTphvaldA",
+  "token_type": "Bearer",
+  "expires_in": 3600
+}
+```
+
+
doc/_includes/oauth-tokens-password.html
@@ -6,11 +6,11 @@ Example curl request:
 ```bash
 $ curl http://localhost:5000/oauth/tokens \
   -X POST \
-  -d '{"grant_type":"password","username":"allen@volkmanweissnat.info","password":"s1b5RDJmQY8G"}' \
+  -d '{"grant_type":"password","username":"sheila_torphy@bechtelar.co.uk","password":"OxlUzuoUOrgV5v"}' \
   -H "Accept: application/json" \
   -H "Content-Type: application/json" \
   -H "User-Agent: net/hippie 0.1.9" \
-  -H "Authorization: Basic YjhkOTgzNTMtMGVjMC00ZTlhLTg0MDItNWE2OWUxZjY5NzZkOkJYd0RybjlWcWFRamRHSjM1OGhuUFNSSg==" \
+  -H "Authorization: Basic MzYzZTczNTUtOTM2NC00Yzg0LTgwMWYtMDU5YjFmZjIwM2I4OnZnY0NyaFJ2bW40WTNUYWVUeWQ1bWlWUQ==" \
   -H "Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3"
 ```
 Request Headers:
@@ -19,7 +19,7 @@ Request Headers:
 Accept: application/json
 Content-Type: application/json
 User-Agent: net/hippie 0.1.9
-Authorization: Basic YjhkOTgzNTMtMGVjMC00ZTlhLTg0MDItNWE2OWUxZjY5NzZkOkJYd0RybjlWcWFRamRHSjM1OGhuUFNSSg==
+Authorization: Basic MzYzZTczNTUtOTM2NC00Yzg0LTgwMWYtMDU5YjFmZjIwM2I4OnZnY0NyaFJ2bW40WTNUYWVUeWQ1bWlWUQ==
 Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3
 ```
 
@@ -28,8 +28,8 @@ Request Body:
 ```json
 {
   "grant_type": "password",
-  "username": "allen@volkmanweissnat.info",
-  "password": "s1b5RDJmQY8G"
+  "username": "sheila_torphy@bechtelar.co.uk",
+  "password": "OxlUzuoUOrgV5v"
 }
 ```
 
@@ -45,8 +45,8 @@ Referrer-Policy: strict-origin-when-cross-origin
 Cache-Control: private, no-store
 Pragma: no-cache
 Content-Type: application/json; charset=utf-8
-Etag: W/"b22c1725b3a24d9a88d0d82adb5ccead"
-X-Request-Id: 5200b121-3660-429b-be52-a2e9b732b2f4
+Etag: W/"2d39b47999b54df9600f05e81426bcf7"
+X-Request-Id: da983f60-ab3c-4d88-823b-cf692e974d3f
 Transfer-Encoding: chunked
 ```
 
@@ -54,10 +54,10 @@ Transfer-Encoding: chunked
 Response Body:
 ```json
 {
-  "access_token": "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE1NDA3NjQ3MzEsImlhdCI6MTU0MDc2MTEzMSwiaXNzIjoiaHR0cDovL3Byb29mLnRlc3QvbWV0YWRhdGEiLCJuYmYiOjE1NDA3NjExMzEsImF1ZCI6ImI4ZDk4MzUzLTBlYzAtNGU5YS04NDAyLTVhNjllMWY2OTc2ZCIsImp0aSI6IjRjYjc0ZjI4LTEwYmEtNDEwYi04NGU5LTg4Mzc2MzQ3NWZjMSIsInN1YiI6IjNiOTRlZGIwLTJlYWItNDAyYi1hZTg2LThmMjVlMmQzMjQ0OSIsInRva2VuX3R5cGUiOiJhY2Nlc3MifQ.PVN9lWyxjibLlQqGQIS-7RIb64YbUanm-kI8GFibEgw4WmrOGNcuk5Te-w6ISNt0RlluIC1lgOOdBBr6vRVZZoUC8T72l26QzbEHjKANq_2aZffyojiGSoiU9KCXHFjTX4RQCFV40vxje8olCs5x3CpkBszfH24eAhFgvSp8IcDg62fwV98gCWb3fAK3evRmN5A5N66zxpLuESuVX8rG0WjCowdEuhC9f3jxLyKpBX2keFpO5Fq2Ina8HlkQhi4UchMwm2eKtEV63T8UVFojDlsDc-J7KNc5yVRR2XeYmaoDrEJ4oPf5OshbOS58yJ6XpENM4onfRW5O2Nof31SU1w",
+  "access_token": "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE1NDA3NjQ5MjIsImlhdCI6MTU0MDc2MTMyMiwiaXNzIjoiaHR0cDovL3Byb29mLnRlc3QvbWV0YWRhdGEiLCJuYmYiOjE1NDA3NjEzMjIsImF1ZCI6IjM2M2U3MzU1LTkzNjQtNGM4NC04MDFmLTA1OWIxZmYyMDNiOCIsImp0aSI6ImI0NDQ1M2UwLTNlM2YtNGU0OS05ZDc2LTNjOWE1MTMzNWNlNyIsInN1YiI6ImVkZTJjMzZlLTcwM2QtNDJkMC04MGIzLTNlYzk0ZmMzZDBiMCIsInRva2VuX3R5cGUiOiJhY2Nlc3MifQ.qqJIgRYh73b0jhLZFEwD-jKfQ5EogHeS6w9g-MYgCbw_l4FeK_fK279hycXzkqU5vu4273I9SFXfz_ftpRiL4xXmlxDusZ6lo_ukYJv_8Uj_nY-tz3fvDvs4uLIAnaSr4GVSX7VjgQMuLJoLplEH-iDPi-VE8HH3KtAhWHF1ddWoLfJbYbmg_-lu-9CmDp-BqD9veDELzpq5OC-D38YHXY7C7xjW3wry8CV37potqkog0xowrFkaqNc9UPZfsJCg_V9GoXN3l59QHv1qgoWItin6TkyhGAc8MgIXTiJeMrMm19YYhNFlUuy67vV5yEOXOzLD6y5-LvcdoR6SOnFkvg",
   "token_type": "Bearer",
   "expires_in": 3600,
-  "refresh_token": "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE1NDA4NDc1MzEsImlhdCI6MTU0MDc2MTEzMSwiaXNzIjoiaHR0cDovL3Byb29mLnRlc3QvbWV0YWRhdGEiLCJuYmYiOjE1NDA3NjExMzEsImF1ZCI6ImI4ZDk4MzUzLTBlYzAtNGU5YS04NDAyLTVhNjllMWY2OTc2ZCIsImp0aSI6IjQ5NDFhMTgyLWNlZDgtNDlhNi1hZTY3LTdlMzQ3YmU3MDgyZCIsInN1YiI6IjNiOTRlZGIwLTJlYWItNDAyYi1hZTg2LThmMjVlMmQzMjQ0OSIsInRva2VuX3R5cGUiOiJyZWZyZXNoIn0.DSvKplo6e_05xQTaYQkmKHDQuOwrFeM45UG5QAH5WxbMtG5MD715PCt7TzySy49A5cOx-n8JC11sMvRmkkB2UncwGmaNyi_4AWVnLeucYIm1ApED71AlNbn8hMr8uWfnFRXUJfA4acbNr0nI1bRC5tChKohkurV2BvMNq60rsMV4NEgjaXja3t5rqURtPAskirMWtYLNGSnVkkYQp_ou6YcRDHn2AtIBygccJDZBQMsCHuU7la32wZmsKeJisujatAu0gI8SZXSAWjX00EVwCMIJ6_yQkTNNvgSQCmvkT4DOPavFM-dgwnbYO1dst1MbxCuVCGDIZTGdehb8YwvjMw"
+  "refresh_token": "eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE1NDA4NDc3MjIsImlhdCI6MTU0MDc2MTMyMiwiaXNzIjoiaHR0cDovL3Byb29mLnRlc3QvbWV0YWRhdGEiLCJuYmYiOjE1NDA3NjEzMjIsImF1ZCI6IjM2M2U3MzU1LTkzNjQtNGM4NC04MDFmLTA1OWIxZmYyMDNiOCIsImp0aSI6Ijc4NTBhNWIxLWM0NGYtNDUyZi1iMTIyLTUyODc0MzRhZDgyZSIsInN1YiI6ImVkZTJjMzZlLTcwM2QtNDJkMC04MGIzLTNlYzk0ZmMzZDBiMCIsInRva2VuX3R5cGUiOiJyZWZyZXNoIn0.VsswVZMFJzL-WmwDerdKunYQquFu4jdIVtDdBA04D6Byqt5mjz1ccsxgevWAQNvmyEvCre55hX_vKSmdvgkxoIBbDCAYhsnaePunUU299Zqw7Fi5SCze0vVRZnJpHst9wzkWQby8VPRyVkOBOftpAV7wmawHXKPmpGuuTl5Vsf_g1Sc8imPFnPec-5PZwbia0fclcSrJ0kwNyzu7_ZEEmdANS1gZJMGiTD1BOgw0uzuX02RJIXzWx3VJpsHF2SqHXfxD5oIIXN6dT65ULbthe5_VxUhVs3_ibbQLund-kEaniHsarPsDV6hqDVdBdn-dOgZcf6RnpBCviw9bKm4lFg"
 }
 ```
 
doc/_posts/2018-10-28-oauth-tokens.markdown
@@ -65,3 +65,18 @@ The Tokens endpoint adheres to [RFC-6749](https://tools.ietf.org/html/rfc6749).
 [Section 4.3](https://tools.ietf.org/html/rfc6749#section-4.3)
 
 {% include oauth-tokens-password.html %}
+
+## Client Credentials Grant
+
+```text
+    +---------+                                  +---------------+
+    |         |                                  |               |
+    |         |>--(A)- Client Authentication --->| Authorization |
+    | Client  |                                  |     Server    |
+    |         |<--(B)---- Access Token ---------<|               |
+    |         |                                  |               |
+    +---------+                                  +---------------+
+```
+[Section 4.4](https://tools.ietf.org/html/rfc6749#section-4.4)
+
+{% include oauth-tokens-client-credentials.html %}
spec/documentation.rb
@@ -59,4 +59,13 @@ RSpec.describe "documentation" do
       expect(response.code).to eql('200')
     end
   end
+
+  specify do
+    headers = { 'Authorization' => ActionController::HttpAuthentication::Basic.encode_credentials(client.to_param, client.password) }
+    body = { grant_type: 'client_credentials' }
+    VCR.use_cassette("oauth-tokens-client-credentials") do
+      response = hippie.post("#{scheme}://#{host}/oauth/tokens", body: body, headers: headers)
+      expect(response.code).to eql('200')
+    end
+  end
 end