Merge pull request oracle-samples#51 from karankap/feature/MPDO-1015

Feature/mpdo 1015

Author: Govinnd

samples/oci-apigw-idcs-auth-basic/README.md

@@ -1,181 +1,204 @@
-# API Gateway Basicauth function using IDCS
-This function provides verification of username and password against IDCS at runtime and allows only authorized users to access  API gateway deployment.
+# API Gateway Basicauth function using Identity Cloud Service (IDCS)
 
-The implementation conforms to the guidelines in the OCI Documentation at https://docs.cloud.oracle.com/en-us/iaas/Content/APIGateway/Tasks/apigatewayusingauthorizerfunction.htm.
+This function provides verification of username and password against IDCS at runtime and allows only authorized users to access API gateway deployment.
+
+The implementation conforms to the [documented guidlines for using authorizer functions to add Authentication and Authorization to API deployments](https://docs.cloud.oracle.com/en-us/iaas/Content/APIGateway/Tasks/apigatewayusingauthorizerfunction.htm).
 
 As you make your way through this tutorial, look out for this icon ![user input icon](./images/userinput.png).
 Whenever you see it, it's time for you to perform an action.
 
-
 ## Prerequisites
 
 [Create users in IDCS](https://docs.oracle.com/en/cloud/paas/identity-cloud/uaids/create-user-accounts.html)
 
-Before you deploy this sample function, make sure you have run step A, B and C of the [Oracle Functions Quick Start Guide for Cloud Shell](https://www.oracle.com/webfolder/technetwork/tutorials/infographics/oci_functions_cloudshell_quickview/functions_quickview_top/functions_quickview/index.html)
-* A - Set up your tenancy
-* B - Create application
-* C - Set up your Cloud Shell dev environment
+Before you deploy this sample function, you need to complete steps A, B and C of the [Oracle Functions Quick Start Guide for Cloud Shell](https://www.oracle.com/webfolder/technetwork/tutorials/infographics/oci_functions_cloudshell_quickview/functions_quickview_top/functions_quickview/index.html)
+
+- A - Set up your tenancy
+- B - Create application
+- C - Set up your Cloud Shell dev environment
 
 ## List Applications
+
 Assuming your have successfully completed the prerequisites, you should see your
 application in the list of applications.
+
 ```
 fn ls apps
 ```
 
 ## Deploy a function that implements an API
+
 We need another function that will be a target for API Gateway. We suggest [oci-display-httprequest-info-python](../oci-display-httprequest-info-python).
-In Cloud Shell, run the *fn deploy* command to build the function and its dependencies as a Docker image,
-push the image to OCIR, and deploy the function to Oracle Functions in your application.
+In Cloud Shell, run `fn deploy` to build the function and its dependencies as a container,
+push the image to Oracle Cloud Infrastructure Registry (OCIR), and deploy the function to Oracle Functions in your application.
 
 ![user input icon](./images/userinput.png)
+
 ```
 cd ../oci-display-httprequest-info-python
 fn -v deploy --app <app-name>
 ```
 
 ## Create or Update your Dynamic Group for API Gateway
+
 In order to invoke functions, your API Gateway must be part of a dynamic group.
 
-When specifying the *Matching Rules*, we suggest matching all functions in a compartment with:
+When specifying the _Matching Rules_, we suggest matching all functions in a compartment with:
+
 ```
 ALL {resource.type = 'ApiGateway', resource.compartment.id = 'ocid1.compartment.oc1..aaaaaxxxxx'}
 ```
 
-
 ## Create or Update IAM Policies for API Gateway
+
 Create a new policy that allows the API Gateway dynamic group to invoke functions. We will grant `use` access to `functions-family` in the compartment.
 
 ![user input icon](./images/userinput.png)
 
 Your policy should look something like this:
+
 ```
 Allow dynamic-group <dynamic-group-name> to use functions-family in compartment <compartment-name>
 ```
 
 For more information on how to create policies, check the [documentation](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policysyntax.htm).
 
-
 ## Configure Identity Cloud Service (IDCS)
+
 Login to IDCS admin console and create, add an Application and select "Confidential Application".
 ![IDCS-appcreate0](./images/IDCS-appcreate0.png)
 
 Enter a name for your IDCS Application, for example "myAPI".
 
 ![IDCS-appcreate1](./images/IDCS-appcreate1.png)
 
-For "Allowed Grant Types", select "Resource Owner". Click *Next*.
+For "Allowed Grant Types", select "Resource Owner". Click _Next_.
 
 ![IDCS-appcreate2](./images/IDCS-appcreate2.png)
 
 For Primary Audience, enter anything "display-httprequest-info" for example.
-For Scopes, click *Add*. In the dialog box, for field "Scope", enter anything "display-httprequest-info" for example, click *Add*.
+For Scopes, click _Add_. In the dialog box, for field "Scope", enter anything "display-httprequest-info" for example, click _Add_.
 
 ![IDCS-appcreate3](./images/IDCS-appcreate3.png)
 
-Click *Next*.
+Click _Next_.
 
 ![IDCS-appcreate4](./images/IDCS-appcreate4.png)
 
-Click *Finish*.
+Click _Finish_.
 
 ![IDCS-appcreate5](./images/IDCS-appcreate5.png)
 
-Now that the application is added, note the *Client ID* and *Client Secret*.
+Now that the application is added, note the _Client ID_ and _Client Secret_.
 
 ![IDCS-appcreate6](./images/IDCS-appcreate6.png)
 
-Click *Close*.
+Click _Close_.
 
-Click on Configurations tab  under Client Information section click on add scope and select the *application name* from the dropdown. Note the scope value.
+Click on Configurations tab under Client Information section click on add scope and select the _application name_ from the dropdown. Note the scope value.
 
 ![IDCS-appcreate7](./images/IDCS-appcreate7.png)
 ![IDCS-appcreate8](./images/IDCS-appcreate8.png)
 
-Click *Activate* and click *Ok* in the dialog.
-
-Note the *IDCS URL*, this is the URL you see in your browser URL bar, copy the IDCS url ( For example: https://idcs-xxxxxxxxxxx.identity.oraclecloud.com/ ), client-id, client-secret and scope these values are provided to the Basicauth function.
-
+Click _Activate_ and click _Ok_ in the dialog.
 
+Note the _IDCS URL_, this is the URL you see in your browser URL bar, copy the IDCS url ( For example: https://idcs-xxxxxxxxxxx.identity.oraclecloud.com/ ), client-id, client-secret and scope these values are provided to the Basicauth function.
 
 ## Review and customize the function
+
 Review the following files in the current folder:
-- [pom.xml](./pom.xml) specifies all the dependencies for your function
-- [func.yaml](./func.yaml) that contains metadata about your function and declares properties
-- [src/main/java/com/example/fn/BasicAuth.java](./src/main/java/com/example/fn/BasicAuth.java) which contains the Java code
 
-The name of your function *basicauth* is specified in [func.yaml](./func.yaml).
+- [`pom.xml`](./pom.xml) specifies all the dependencies for your function
+- [`func.yaml`](./func.yaml) that contains metadata about your function and declares properties
+- [`src/main/java/com/example/fn/BasicAuth.java`](./src/main/java/com/example/fn/BasicAuth.java) which contains the Java code
 
-set the following variable in "src/main/java/com/example/utils/ResourceServerConfig.java" to the values  noted while configuring IDCS.
-```
-public static final String CLIENT_ID = "xxxxxxxxxxx";
-public static final String CLIENT_SECRET = "xxxxxxxxx";
-public static final String IDCS_URL = "https://idcs-xxxxxxxx.identity.oraclecloud.com";
+The name of your function `basicauth` is specified in [`func.yaml`](./func.yaml).
+
+set the following config variables to the values noted while configuring IDCS. The IDCS URL is the token endpoint that returns the access token after validating credentials
+
+```java
+CLIENT_ID = "xxxxxxxxxxx";
+CLIENT_SECRET = "xxxxxxxxx";
+IDCS_URL = "https://idcs-xxxxxxxx.identity.oraclecloud.com/oauth2/v1/token";
 
 //INFORMATION ABOUT THE TARGET APPLICATION
-public static final String SCOPE_AUD = "display-httprequest-infodisplay-httprequest-info";
+SCOPE_AUD = "display-httprequest-infodisplay-httprequest-info";
 ```
 
+For the unit test to run, set the following variables in src/test/java/com/example/fn/BasicAuthTest.java
+
+```java
+    private static final String TEST_IDCS_URL = "https://idcs-xxxxxxxx.identity.oraclecloud.com/oauth2/v1/token";
+    private static final String TEST_CLIENT_ID = "xxxxxxxxxxx";
+    private static final String TEST_CLIENT_SECRET = "xxxxxxxxxxx";
+    private static final String TEST_SCOPE_AUD = "display-httprequest-infodisplay-httprequest-info";
+    private static final String TEST_TOKEN = "xxxxxxxxxxx";
+```
 
 ## Deploy the basicauth function
-In Cloud Shell, run the *fn deploy* command to build the function and its dependencies as a Docker image,
+
+In Cloud Shell, run `fn deploy` to build the function and its dependencies as a container,
 push the image to OCIR, and deploy the function to Oracle Functions in your application.
 
 ![user input icon](./images/userinput.png)
-```
+
+```shell
 fn -v deploy --app <app-name>
 ```
+
 ## Invoke the basicauth function in cloud shell
-In Cloud Shell, run *fn invoke* command to invoke the deployed function, returns active status as true if the token is valid or else returns false.
+
+In Cloud Shell, run `fn invoke` to invoke the deployed function. It should return an active status of true if the token is valid or otherwise returns false.
 
 ![user input icon](./images/userinput.png)
-```
+
+```shell
 echo -n '{"type":"TOKEN", "token":"Basic aW5jaGFyYS5zaGFtYW5uYUBvcmFj....."}' | fn invoke <app-name> <func-name>
 ```
 
 ## Create the API Gateway
+
 The functions is meant to be invoked through API Gateway.
 
 ![user input icon](./images/userinput.png)
 
-On the OCI console, navigate to *Developer Services* > *API Gateway*. Click on *Create Gateway*. Provide a name, set the type to "Public", select a compartment, a VCN, a public subnet, and click *Create*.
+On the OCI console, navigate to _Developer Services_ > _API Gateway_. Click on _Create Gateway_. Provide a name, set the type to "Public", select a compartment, a VCN, a public subnet, and click _Create_.
 
 ![APIGW create](./images/apigw-create.png)
 
-Once created, click on your gateway. Under *Resources*, select *Deployments* and click *Create Deployment*.
+Once created, click on your gateway. Under _Resources_, select _Deployments_ and click _Create Deployment_.
 
-* Provide a name, a path prefix ("/basicauth" for example).
-* Under *API Request Policies* Add Authentication
-    * Authentication Type: *Custom*
-    * Choose the application and the basicauth function
-    * For "Authentication token", select *Header*
-    * For the "Header Name", enter "Autorization"
+- Provide a name, a path prefix ("/basicauth" for example).
+- Under _API Request Policies_ Add Authentication
+  - Authentication Type: _Custom_
+  - Choose the application and the basicauth function
+  - For "Authentication token", select _Header_
+  - For the "Header Name", enter "Autorization"
 
-Click *Save Changes* when you are finished
+Click _Save Changes_ when you are finished
 ![APIGW deployment create](./images/apigw-deployment-create.png)
 
-Click *Next*. Provide a name to the route ("/hello" for example), select methods eg: "GET", select *HTTP-URL* for your back-end.
+Click _Next_. Provide a name to the route ("/hello" for example), select methods eg: "GET", select _HTTP-URL_ for your back-end.
 
 ![APIGW deployment create](./images/apigw-deployment-create-route.png)
 
-Click *Next* and finally, click *Save Changes*.
+Click _Next_ and finally, click _Save Changes_.
 
 Note the endpoint of your API Gateway deployment.
 
 ![APIGW deployment endpoint](./images/apigw-deployment-endpoint.png)
 
-
 ## Invoke the Deployment endpoint
+
 The function validates if the user information is valid.
 
 ![user input icon](./images/userinput.png)
 
-Use the curl command to make the HTTP request
-```
+Use `curl` to make the HTTP request
+
+```shell
  curl -i -u "<username>:<password>" https://d6xxxxxxxxk64.apigateway.us-ashburn-1.oci.customer-oci.com/basicauth/hello
 ```
+
 If the user is valid gateway will make a call to backend with HTTP200 else
 The gateway will reject the request with an HTTP401.
-
-
-

samples/oci-apigw-idcs-auth-basic/func.yaml

@@ -1,7 +1,9 @@
 schema_version: 20180708
 name: basicauth
-version: 0.0.6
+version: 0.0.21
 runtime: java
 build_image: fnproject/fn-java-fdk-build:jdk11-1.0.146
 run_image: fnproject/fn-java-fdk:jre11-1.0.146
 cmd: com.example.fn.BasicAuth::handleRequest
+memory: 512
+timeout: 120

samples/oci-apigw-idcs-auth-basic/pom.xml

@@ -1,15 +1,15 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <fdk.version>1.0.146</fdk.version>
+        <jdk.version>11</jdk.version>
     </properties>
+
     <groupId>com.example.fn</groupId>
     <artifactId>basicAuth</artifactId>
-    <version>1.0.0</version>
+    <version>1.0.1</version>
 
     <dependencies>
         <dependency>
@@ -49,18 +49,18 @@
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>3.3</version>
                 <configuration>
-                    <source>11</source>
-                    <target>11</target>
+                    <source>${jdk.version}</source>
+                    <target>${jdk.version}</target>
                 </configuration>
             </plugin>
             <plugin>
-                 <groupId>org.apache.maven.plugins</groupId>
-                 <artifactId>maven-surefire-plugin</artifactId>
-                 <version>2.22.1</version>
-                 <configuration>
-                     <useSystemClassLoader>false</useSystemClassLoader>
-                 </configuration>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>2.22.1</version>
+                <configuration>
+                    <useSystemClassLoader>false</useSystemClassLoader>
+                </configuration>
             </plugin>
         </plugins>
     </build>
-</project>
+</project>