| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <main role="main"> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span><a id="line.1">package org.apache.archiva.redback.rest.api.services.v2;</a> |
| <span class="sourceLineNo">002</span><a id="line.2"></a> |
| <span class="sourceLineNo">003</span><a id="line.3">/*</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> *</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">019</span><a id="line.19"> * under the License.</a> |
| <span class="sourceLineNo">020</span><a id="line.20"> */</a> |
| <span class="sourceLineNo">021</span><a id="line.21"></a> |
| <span class="sourceLineNo">022</span><a id="line.22">import io.swagger.v3.oas.annotations.Operation;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import io.swagger.v3.oas.annotations.media.Content;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import io.swagger.v3.oas.annotations.media.Schema;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import io.swagger.v3.oas.annotations.responses.ApiResponse;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import io.swagger.v3.oas.annotations.security.SecurityRequirement;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import io.swagger.v3.oas.annotations.tags.Tag;</a> |
| <span class="sourceLineNo">028</span><a id="line.28">import org.apache.archiva.redback.authorization.RedbackAuthorization;</a> |
| <span class="sourceLineNo">029</span><a id="line.29">import org.apache.archiva.redback.rest.api.model.RedbackRestError;</a> |
| <span class="sourceLineNo">030</span><a id="line.30">import org.apache.archiva.redback.rest.api.model.v2.PingResult;</a> |
| <span class="sourceLineNo">031</span><a id="line.31">import org.apache.archiva.redback.rest.api.model.v2.TokenRefreshRequest;</a> |
| <span class="sourceLineNo">032</span><a id="line.32">import org.apache.archiva.redback.rest.api.model.v2.TokenRequest;</a> |
| <span class="sourceLineNo">033</span><a id="line.33">import org.apache.archiva.redback.rest.api.model.v2.TokenResponse;</a> |
| <span class="sourceLineNo">034</span><a id="line.34">import org.apache.archiva.redback.rest.api.model.v2.UserInfo;</a> |
| <span class="sourceLineNo">035</span><a id="line.35">import org.apache.archiva.redback.rest.api.services.RedbackServiceException;</a> |
| <span class="sourceLineNo">036</span><a id="line.36"></a> |
| <span class="sourceLineNo">037</span><a id="line.37">import javax.ws.rs.Consumes;</a> |
| <span class="sourceLineNo">038</span><a id="line.38">import javax.ws.rs.GET;</a> |
| <span class="sourceLineNo">039</span><a id="line.39">import javax.ws.rs.POST;</a> |
| <span class="sourceLineNo">040</span><a id="line.40">import javax.ws.rs.Path;</a> |
| <span class="sourceLineNo">041</span><a id="line.41">import javax.ws.rs.Produces;</a> |
| <span class="sourceLineNo">042</span><a id="line.42">import javax.ws.rs.core.MediaType;</a> |
| <span class="sourceLineNo">043</span><a id="line.43"></a> |
| <span class="sourceLineNo">044</span><a id="line.44">import static javax.ws.rs.core.MediaType.APPLICATION_JSON;</a> |
| <span class="sourceLineNo">045</span><a id="line.45"></a> |
| <span class="sourceLineNo">046</span><a id="line.46">/**</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * Authentication service</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> *</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * @author Martin Stockhammer</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * @since 3.0</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> */</a> |
| <span class="sourceLineNo">052</span><a id="line.52">@Path( "/auth" )</a> |
| <span class="sourceLineNo">053</span><a id="line.53">@Tag(name = "v2")</a> |
| <span class="sourceLineNo">054</span><a id="line.54">@Tag(name = "v2/Authentication")</a> |
| <span class="sourceLineNo">055</span><a id="line.55">@Consumes( { MediaType.APPLICATION_JSON })</a> |
| <span class="sourceLineNo">056</span><a id="line.56">public interface AuthenticationService</a> |
| <span class="sourceLineNo">057</span><a id="line.57">{</a> |
| <span class="sourceLineNo">058</span><a id="line.58"></a> |
| <span class="sourceLineNo">059</span><a id="line.59"> /**</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * Just a ping request / response for checking availability of the server</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * @return the ping result</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * @throws RedbackServiceException</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> */</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> @Path( "ping" )</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> @GET</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> @Produces( { MediaType.APPLICATION_JSON } )</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> @RedbackAuthorization( noRestriction = true )</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> @Operation( summary = "Ping request.",</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> responses = {</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> @ApiResponse( responseCode = "200",</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> description = "Pong",</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = PingResult.class))</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> )</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> })</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> PingResult ping()</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">077</span><a id="line.77"></a> |
| <span class="sourceLineNo">078</span><a id="line.78"></a> |
| <span class="sourceLineNo">079</span><a id="line.79"> /**</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> * This ping request is only successful, if the provided Bearer token is valid and authenticates a existing user</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> * @return the ping result or a failure message</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> * @throws RedbackServiceException</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> */</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> @Path( "ping/authenticated" )</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> @GET</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> @Produces( { MediaType.APPLICATION_JSON } )</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> @RedbackAuthorization( noRestriction = false, noPermission = true )</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> @Operation( summary = "Ping request to restricted service. You have to provide a valid authentication token.",</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> responses = {</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> @ApiResponse( responseCode = "200",</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> description = "Pong",</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = PingResult.class))</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> ),</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> @ApiResponse( responseCode = "403", description = "Authenticated user is not permitted to ping",</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) )</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> })</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> @SecurityRequirement( name="BearerAuth" )</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> PingResult pingWithAutz()</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">100</span><a id="line.100"></a> |
| <span class="sourceLineNo">101</span><a id="line.101"> /**</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> * Check username/password and return a bearer token.</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> * The bearer token can be added to the HTTP header on further requests to authenticate.</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> *</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> */</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> @Path( "authenticate" )</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> @POST</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> @RedbackAuthorization( noRestriction = true, noPermission = true )</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> @Produces( { MediaType.APPLICATION_JSON } )</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> @Operation( summary = "Authenticate by user/password login and return a bearer token, usable for further requests",</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> responses = {</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> @ApiResponse( description = "A access token, that has to be added to the Authorization header on authenticated requests. " +</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> "And refresh token, used to refresh the access token. Each token as a lifetime. After expiration it cannot be used anymore.",</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = TokenResponse.class))</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> ),</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> @ApiResponse( responseCode = "401", description = "Authentication failed. The response body tells more about the failure.",</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) ),</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> @ApiResponse( responseCode = "403", description = "Authenticated user is not permitted to gather the information",</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) )</a> |
| <span class="sourceLineNo">120</span><a id="line.120"></a> |
| <span class="sourceLineNo">121</span><a id="line.121"> }</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> )</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> TokenResponse logIn( TokenRequest loginRequest )</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">125</span><a id="line.125"></a> |
| <span class="sourceLineNo">126</span><a id="line.126"> /**</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> * Request a new token.</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> */</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> @Path( "token" )</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> @POST</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> @RedbackAuthorization( noPermission = true )</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> @Produces( { MediaType.APPLICATION_JSON } )</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> @Operation( summary = "Creates a new access token based on the given payload. Currently only grant_type=refresh_token is "+</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> "supported. You have to provide the refresh token in the payload. And you have to provide a valid Bearer access token in "+</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> "the Authorization header.",</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> responses = {</a> |
| <span class="sourceLineNo">137</span><a id="line.137"> @ApiResponse( description = "The new access token",</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = TokenResponse.class)))</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> }</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> )</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> @SecurityRequirement( name="BearerAuth" )</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> TokenResponse token( TokenRefreshRequest tokenRequest )</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">144</span><a id="line.144"></a> |
| <span class="sourceLineNo">145</span><a id="line.145"></a> |
| <span class="sourceLineNo">146</span><a id="line.146"> /**</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> * Check, if the current request is authenticated and if so return the current user data</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> */</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> @Path( "authenticated" )</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> @GET</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> @Produces( { MediaType.APPLICATION_JSON } )</a> |
| <span class="sourceLineNo">152</span><a id="line.152"> @RedbackAuthorization( noRestriction = true )</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> @Operation(summary = "Checks the request for a valid access token, and returns the user object that corresponds to the " +</a> |
| <span class="sourceLineNo">154</span><a id="line.154"> "provided token.",</a> |
| <span class="sourceLineNo">155</span><a id="line.155"> responses = {</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> @ApiResponse( description = "The new access token",</a> |
| <span class="sourceLineNo">157</span><a id="line.157"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = UserInfo.class)))</a> |
| <span class="sourceLineNo">158</span><a id="line.158"> }</a> |
| <span class="sourceLineNo">159</span><a id="line.159"> )</a> |
| <span class="sourceLineNo">160</span><a id="line.160"> UserInfo getAuthenticatedUser()</a> |
| <span class="sourceLineNo">161</span><a id="line.161"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">162</span><a id="line.162"></a> |
| <span class="sourceLineNo">163</span><a id="line.163">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
