been a while again..
today i'm back to write on how to write the simplest possible spring boot app protected with spring security oauth2, but i'll also make the project as a library jar that can be reused for any new projects to kick off faster.
and it will be a simple ready to override functions that will let you focus on configuring only things that you need to worry about without having to worry about annotations or other spring security stuff.
Spring security oauth 2 has three main components :
a- Authorization server: to handle tokens/authroization codes and user approve/deny
b- Resource server: protects the actual apis that we want to be protected by oauth2
c- spring web security configs to manage users authentication
and as simple as it sounds to get these three in one simple hello world example required hours and hours of searching and debugging dont ask me why..
Pre Requests :
1- you know spring security & spring web security concepts and how to configure it like basic auth or form login
so without further due here are the three classes you will need to get oauth2 up and running :
1- Spring security:
this class extends the Spring web security configurer to allow us to set how we want to protect our authorization server, and to set up our users (Resource owners) store. here it's in memory but in your application you will need jdbc so you can just extend and override this.
by default this protects /oauth/authroize api with the default spring web security login form
when you need to override that form you should override this method :
protected void configure(HttpSecurity http)
and set the url of the login page of your choice using the usual spring web security configs.
2- Authroization server:
here this configuration server has two main parts :
A- configure(ClientDetailsServiceConfigurer clients)
this method configures the clients of our oauth2 resource, and clients in 90% of the cases in the world of oauth2 represents the 3rd party apps that want to access the resource owner data on his behalf (as example of that is when you allow a web or mobile application to access your instagram photos or facebook friends list)
B- configure(AuthorizationServerEndpointsConfigurer endpoints)
this method let you configure the oauth2 endpoints settings as: where to store the tokens, codes, and many other customizations that are usually not needed (the most important one is setting the token store)
3- Resource Server.java
here we can configure 2 important things
1- configure(ResourceServerSecurityConfigurer resources)
this can allow us to configure the id of this resource server (becomes handy if we have multiple resource servers and we have access rules for different clients on each of them) and the more important config is the token store, i.e. where to verify the tokens that we receive in the requests and make sure they are authentic and created by our Authorization server.
2- configure(HttpSecurity http)
this is important and allows us to configure the urls that we want to protect under the oauth2 protocl in this resource, anything we specify here will require a valid token that can access this resource propery and in my default configuration i protected any api under the path /protected to be fully authenticated, now this is app specific configs because each app has its own apis and roles and security rules, so make sure you understand how to use the HttpSecurity builder
it worths mentioning the oauth2 spring libraries provide some exprissions like hasScope() and other security functions related to oauth2 security.
now how to use these classes?
you just have to add this jar in your deps in maven or gradle or whatever and import these 3 classes to your spring configurations, I have made an example in this client project:
this is simple spring boot application and in it, just for practicing i overrode the method that configures clients in Authorization server and added my own client.. this can be converted to jdbc or whatever you want
and for the other 2 classes I haven't changed anything so I just imported them as is, if I haven't changed anything in Authorization server I would have also just imported it, but it will be scanned automatically since we extended it and annotated it with @Configration
and when we run the application and as for a protected (although non existing) url like :
so to get a token there are many flows but the more complex and more typical that we would use oauth2 for is authorization code flow, so to obtaina token go to the browser and type in :
this will redirect us to login page where this is similar to when you are redirected to facebook by a third party app to login and approve its permissions to get some of your data
so we login with our dummy in memory user setup in the spring security configs:
then you get the approval of scopes page
and if the user approves, then the server will issue an authorization code and return it to the 3rd party app on the redirect uri provided
the 3rd party server now should exchange that code with our server to an access token
after getting the token it can now use it to access the protected resoruce that we couldn't access before
Simple and clean and ready to be used out of the box just get the jar of the oauth2lw-core and drop it in your project and you will have oauth2 security ready.
note that the core lib pom already have the required deps:
so no need for you to worry about it..
Nice work! are you going to put it on maven repositories?ReplyDelete