|
| 1 | +# API Gateway Basicauth function using IDCS |
| 2 | +This function provides verification of username and password against IDCS at runtime and allows only authorized users to access API gateway deployment. |
| 3 | + |
| 4 | +The implementation conforms to the guidelines in the OCI Documentation at https://docs.cloud.oracle.com/en-us/iaas/Content/APIGateway/Tasks/apigatewayusingauthorizerfunction.htm. |
| 5 | + |
| 6 | +As you make your way through this tutorial, look out for this icon . |
| 7 | +Whenever you see it, it's time for you to perform an action. |
| 8 | + |
| 9 | + |
| 10 | +## Prerequisites |
| 11 | + |
| 12 | +[Create users in IDCS](https://docs.oracle.com/en/cloud/paas/identity-cloud/uaids/create-user-accounts.html) |
| 13 | + |
| 14 | +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) |
| 15 | +* A - Set up your tenancy |
| 16 | +* B - Create application |
| 17 | +* C - Set up your Cloud Shell dev environment |
| 18 | + |
| 19 | +## List Applications |
| 20 | +Assuming your have successfully completed the prerequisites, you should see your |
| 21 | +application in the list of applications. |
| 22 | +``` |
| 23 | +fn ls apps |
| 24 | +``` |
| 25 | + |
| 26 | +## Deploy a function that implements an API |
| 27 | +We need another function that will be a target for API Gateway. We suggest [oci-display-httprequest-info-python](../oci-display-httprequest-info-python). |
| 28 | +In Cloud Shell, run the *fn deploy* command to build the function and its dependencies as a Docker image, |
| 29 | +push the image to OCIR, and deploy the function to Oracle Functions in your application. |
| 30 | + |
| 31 | + |
| 32 | +``` |
| 33 | +cd ../oci-display-httprequest-info-python |
| 34 | +fn -v deploy --app <app-name> |
| 35 | +``` |
| 36 | + |
| 37 | +## Create or Update your Dynamic Group for API Gateway |
| 38 | +In order to invoke functions, your API Gateway must be part of a dynamic group. |
| 39 | + |
| 40 | +When specifying the *Matching Rules*, we suggest matching all functions in a compartment with: |
| 41 | +``` |
| 42 | +ALL {resource.type = 'ApiGateway', resource.compartment.id = 'ocid1.compartment.oc1..aaaaaxxxxx'} |
| 43 | +``` |
| 44 | + |
| 45 | + |
| 46 | +## Create or Update IAM Policies for API Gateway |
| 47 | +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. |
| 48 | + |
| 49 | + |
| 50 | + |
| 51 | +Your policy should look something like this: |
| 52 | +``` |
| 53 | +Allow dynamic-group <dynamic-group-name> to use functions-family in compartment <compartment-name> |
| 54 | +``` |
| 55 | + |
| 56 | +For more information on how to create policies, check the [documentation](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policysyntax.htm). |
| 57 | + |
| 58 | + |
| 59 | +## Configure Identity Cloud Service (IDCS) |
| 60 | +Login to IDCS admin console and create, add an Application and select "Confidential Application". |
| 61 | + |
| 62 | + |
| 63 | +Enter a name for your IDCS Application, for example "myAPI". |
| 64 | + |
| 65 | + |
| 66 | + |
| 67 | +For "Allowed Grant Types", select "Resource Owner". Click *Next*. |
| 68 | + |
| 69 | + |
| 70 | + |
| 71 | +For Primary Audience, enter anything "display-httprequest-info" for example. |
| 72 | +For Scopes, click *Add*. In the dialog box, for field "Scope", enter anything "display-httprequest-info" for example, click *Add*. |
| 73 | + |
| 74 | + |
| 75 | + |
| 76 | +Click *Next*. |
| 77 | + |
| 78 | + |
| 79 | + |
| 80 | +Click *Finish*. |
| 81 | + |
| 82 | + |
| 83 | + |
| 84 | +Now that the application is added, note the *Client ID* and *Client Secret*. |
| 85 | + |
| 86 | + |
| 87 | + |
| 88 | +Click *Close*. |
| 89 | + |
| 90 | +Click on Configurations tab under Client Information section click on add scope and select the *application name* from the dropdown. Note the scope value. |
| 91 | + |
| 92 | + |
| 93 | + |
| 94 | + |
| 95 | +Click *Activate* and click *Ok* in the dialog. |
| 96 | + |
| 97 | +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. |
| 98 | + |
| 99 | + |
| 100 | + |
| 101 | +## Review and customize the function |
| 102 | +Review the following files in the current folder: |
| 103 | +- [pom.xml](./pom.xml) specifies all the dependencies for your function |
| 104 | +- [func.yaml](./func.yaml) that contains metadata about your function and declares properties |
| 105 | +- [src/main/java/com/example/fn/BasicAuth.java](./src/main/java/com/example/fn/BasicAuth.java) which contains the Java code |
| 106 | + |
| 107 | +The name of your function *basicauth* is specified in [func.yaml](./func.yaml). |
| 108 | + |
| 109 | +set the following variable in "src/main/java/com/example/utils/ResourceServerConfig.java" to the values noted while configuring IDCS. |
| 110 | +``` |
| 111 | +public static final String CLIENT_ID = "xxxxxxxxxxx"; |
| 112 | +public static final String CLIENT_SECRET = "xxxxxxxxx"; |
| 113 | +public static final String IDCS_URL = "https://idcs-xxxxxxxx.identity.oraclecloud.com"; |
| 114 | +
|
| 115 | +//INFORMATION ABOUT THE TARGET APPLICATION |
| 116 | +public static final String SCOPE_AUD = "display-httprequest-infodisplay-httprequest-info"; |
| 117 | +``` |
| 118 | + |
| 119 | + |
| 120 | +## Deploy the basicauth function |
| 121 | +In Cloud Shell, run the *fn deploy* command to build the function and its dependencies as a Docker image, |
| 122 | +push the image to OCIR, and deploy the function to Oracle Functions in your application. |
| 123 | + |
| 124 | + |
| 125 | +``` |
| 126 | +fn -v deploy --app <app-name> |
| 127 | +``` |
| 128 | +## Invoke the basicauth function in cloud shell |
| 129 | +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. |
| 130 | + |
| 131 | + |
| 132 | +``` |
| 133 | +echo -n '{"type":"TOKEN", "token":"Basic aW5jaGFyYS5zaGFtYW5uYUBvcmFj....."}' | fn invoke <app-name> <func-name> |
| 134 | +``` |
| 135 | + |
| 136 | +## Create the API Gateway |
| 137 | +The functions is meant to be invoked through API Gateway. |
| 138 | + |
| 139 | + |
| 140 | + |
| 141 | +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*. |
| 142 | + |
| 143 | + |
| 144 | + |
| 145 | +Once created, click on your gateway. Under *Resources*, select *Deployments* and click *Create Deployment*. |
| 146 | + |
| 147 | +* Provide a name, a path prefix ("/basicauth" for example). |
| 148 | +* Under *API Request Policies* Add Authentication |
| 149 | + * Authentication Type: *Custom* |
| 150 | + * Choose the application and the basicauth function |
| 151 | + * For "Authentication token", select *Header* |
| 152 | + * For the "Header Name", enter "Autorization" |
| 153 | + |
| 154 | +Click *Save Changes* when you are finished |
| 155 | + |
| 156 | + |
| 157 | +Click *Next*. Provide a name to the route ("/hello" for example), select methods eg: "GET", select *HTTP-URL* for your back-end. |
| 158 | + |
| 159 | + |
| 160 | + |
| 161 | +Click *Next* and finally, click *Save Changes*. |
| 162 | + |
| 163 | +Note the endpoint of your API Gateway deployment. |
| 164 | + |
| 165 | + |
| 166 | + |
| 167 | + |
| 168 | +## Invoke the Deployment endpoint |
| 169 | +The function validates if the user information is valid. |
| 170 | + |
| 171 | + |
| 172 | + |
| 173 | +Use the curl command to make the HTTP request |
| 174 | +``` |
| 175 | + curl -i -u "<username>:<password>" https://d6xxxxxxxxk64.apigateway.us-ashburn-1.oci.customer-oci.com/basicauth/hello |
| 176 | +``` |
| 177 | +If the user is valid gateway will make a call to backend with HTTP200 else |
| 178 | +The gateway will reject the request with an HTTP401. |
| 179 | + |
| 180 | + |
| 181 | + |
0 commit comments