Naudojant „REST-assured“ bandant „OAuth 2.0“ srauto pavyzdžius

OAuth 2.0 pateikia keturis skirtingus srautus, tačiau pagrindinis kiekvieno srauto tikslas yra gauti access_token ir naudoti jį saugomiems ištekliams pasiekti.

Keturi skirtingi srautai yra šie:

• Leidimo kodo suteikimas
• Numanomas dotacijos srautas
• Kliento duomenys
• Slaptažodžio suteikimo srautas

Šioje pamokoje pateikiami kodų pavyzdžiai, naudojant „REST-assured“, norint patikrinti „OAuth 2.0“ srautus, „Authorization Code Grant“ ir „Client Credential“ srautus.

Leidimo kodo dotacijos srautas

Tai yra labiausiai paplitęs srautas, kai kodas išduodamas ir naudojamas norint gauti prieigos raktas . Vartotojui prisijungus, šis kodas perkeliamas į išorinę programą (naršyklėje). „Access_token“ išduodamas serverio pusėje, autentifikuojant klientą jo slaptažodžiu ir gautu kodu.

Trijų žingsnių procesas:

• 1 - gaukite autentišką kodą
• 2 - Gaukite prieigos raktą
• 3 - naudokite prieigos raktą (norėdami pasiekti saugomus išteklius)

Gaukite autentišką kodą

Pirmasis žingsnis - gauti code:

import io.restassured.RestAssured; import io.restassured.http.ContentType; import io.restassured.response.Response; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Test; import static io.restassured.RestAssured.given; import java.util.Base64; public class RestAssuredOAuth2 {
public static String clientId = 'some_client_id';
public static String redirectUri = 'some_redirect_uri';
public static String scope = 'some_scope';
public static String username = 'some_email';
public static String password = 'some_password';
public static String encode(String str1, String str2) {
return new String(Base64.getEncoder().encode((str1 + ':' + str2).getBytes()));
}
public static Response getCode() {
String authorization = encode(username, password);

return


given()




.header('authorization', 'Basic ' + authorization)




.contentType(ContentType.URLENC)




.formParam('response_type', 'code')




.queryParam('client_id', clientId)




.queryParam('redirect_uri', redirectUri)




.queryParam('scope', scope)




.post('/oauth2/authorize')




.then()




.statusCode(200)




.extract()




.response();
}
public static String parseForOAuth2Code(Response response) {
return response.jsonPath().getString('code');
}
@BeforeAll
public static void setup() {
RestAssured.baseURI = 'https://some-url.com';
}
@Test
public void iShouldGetCode() {
Response response = getCode();
String code = parseForOAuth2Code(response);

Assertions.assertNotNull(code);
} }

Gaukite prieigos raktą

Gavę autorizacijos kodą, galime paprašyti access_token

public static Response getToken(String authCode) {
String authorization = encode(username, password);
return
given()

.header('authorization', 'Basic ' + authorization)

.contentType(ContentType.URLENC)

.queryParam('code', authCode)

.queryParam('redirect_uri', redirectUri)

.queryParam('grant_type', grantType)

.post('/oauth2/token')

.then()

.statusCode(200)

.extract()

.response();
}
public static String parseForAccessToken(Response loginResponse) {
return loginResponse.jsonPath().getString('access_token');
}
@Test
public void iShouldGetToken() {
Response tokenResponse = getToken(code);
String accessToken = parseForAccessToken(tokenResponse);
Assertions.assertNotNull(accessToken);
}

„Access Token“ naudojimas

Galiausiai, kai turėsime galiojančią access_token, tada galėsime pateikti užklausas dėl saugomų išteklių:

public static void getUsers() {
given().auth()
.oauth2(accessToken)
.when()
.get('/users')
.then()
.statusCode(200); }

Taip pat galime atsiųsti prieigos raktą kaip Authorization Header su Bearer priešdėlis:

Pavyzdžiui:

public static void getUsers() {
given()
.header('Authorization', 'Bearer ' + accessToken)
.when()
.get('/users')
.then()
.statusCode(200); }

Kliento prisijungimo duomenų srautas

Kliento kredencialų sraute nėra vartotojo sąsajos (naršyklės) ir jis daugiausia naudojamas mašinų tarpusavio autorizavimui.

„REST-assured“ atveju tai atrodys taip:

import io.restassured.RestAssured; import io.restassured.http.ContentType; import io.restassured.response.Response; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Test; import static io.restassured.RestAssured.given; import static io.restassured.RestAssured.requestSpecification; public class RestAssuredOAuth2 {
public static Response response;
private String userAdminClientId = System.getenv('M2M_USER_ADMIN_CLIENT_ID');
private String userAdminClientSecret = System.getenv('M2M_USER_ADMIN_CLIENT_SECRET');
private String oauth2Payload = '{ ' +

' 'client_id': '' + userAdminClientId + '', ' +

' 'client_secret': '' + userAdminClientSecret + '', ' +

' 'audience': 'https://some-url.com/user', ' +

' 'grant_type': 'client_credentials', ' +

' 'scope': 'user:admin' }';
private static String createUserPayload = '{ ' +

' 'username': 'api-user', ' +

' 'email': 'api-user@putsbox.com', ' +

' 'password': 'Passw0rd123!', ' +

' 'firstName': 'my-first-name', ' +

' 'lastName': 'my-last-name', ' +

' 'roles': ['read'] }';
public void userAdminConfigSetup() {
requestSpecification = given().auth().oauth2(getAccessToken(oauth2Payload))


.header('Accept', ContentType.JSON.getAcceptHeader())


.contentType(ContentType.JSON);
}
public String getAccessToken(String payload) {
return given()


.contentType(ContentType.JSON)


.body(payload)


.post('/token')


.then().extract().response()


.jsonPath().getString('access_token');
}
@BeforeAll
public static void setup() {
RestAssured.baseURI = 'https://some-url.com';
}
@Test
public void createUser() {
userAdminConfigSetup();
response = given(requestSpecification)


.body(createUserPayload)


.post('/user')


.then().extract().response();

Assertions.assertEquals(201, response.statusCode());
} }

Išvada

Čia mes pateikėme kodų pavyzdžius su REST patikinimu, kaip gauti access_token naudojant OAuth 2.0 srautus. Kai gausime access_token tada galime pateikti užklausas dėl saugomų išteklių.

Tikiuosi, kad pirmiau minėti dalykai jums buvo naudingi.