├── .gitignore
├── .mvn
└── wrapper
│ ├── maven-wrapper.jar
│ └── maven-wrapper.properties
├── README.md
├── mvnw
├── mvnw.cmd
├── pom.xml
└── src
├── main
├── java
│ └── com
│ │ └── template
│ │ └── auth
│ │ ├── AuthApplication.java
│ │ ├── controllers
│ │ ├── AdviceController.java
│ │ ├── AuthController.java
│ │ ├── GroupController.java
│ │ ├── RoleController.java
│ │ └── UserController.java
│ │ ├── dto
│ │ ├── ErroDto.java
│ │ ├── GroupRequestDto.java
│ │ ├── LoginRequest.java
│ │ ├── Message.java
│ │ ├── TokenResponse.java
│ │ └── UserRequestDto.java
│ │ ├── exceptions
│ │ └── RequestException.java
│ │ ├── interfaces
│ │ └── UserInterface.java
│ │ ├── model
│ │ ├── Group.java
│ │ ├── MyUserPrincipal.java
│ │ ├── Role.java
│ │ └── User.java
│ │ ├── repository
│ │ ├── GroupRepository.java
│ │ ├── RoleRepository.java
│ │ └── UserRepository.java
│ │ ├── security
│ │ ├── JwtAuthFilter.java
│ │ ├── JwtUtils.java
│ │ └── SecurityConfig.java
│ │ └── services
│ │ ├── GroupService.java
│ │ ├── RoleService.java
│ │ ├── UserDetailService.java
│ │ └── UserService.java
└── resources
│ └── application.properties
└── test
└── java
└── com
└── template
└── auth
├── AuthApplicationTests.java
├── controllers
└── AuthControllerTest.java
├── security
└── JwtUtilsTest.java
└── services
└── UserServiceTest.java
/.gitignore:
--------------------------------------------------------------------------------
1 | HELP.md
2 | target/
3 | !.mvn/wrapper/maven-wrapper.jar
4 | !**/src/main/**/target/
5 | !**/src/test/**/target/
6 |
7 | ### STS ###
8 | .apt_generated
9 | .classpath
10 | .factorypath
11 | .project
12 | .settings
13 | .springBeans
14 | .sts4-cache
15 |
16 | ### IntelliJ IDEA ###
17 | .idea
18 | *.iws
19 | *.iml
20 | *.ipr
21 |
22 | ### NetBeans ###
23 | /nbproject/private/
24 | /nbbuild/
25 | /dist/
26 | /nbdist/
27 | /.nb-gradle/
28 | build/
29 | !**/src/main/**/build/
30 | !**/src/test/**/build/
31 |
32 | ### VS Code ###
33 | .vscode/
34 |
--------------------------------------------------------------------------------
/.mvn/wrapper/maven-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/igmer/spring-auth/e81c8c4a6e85723e7a26ab5c0e2b9e0316ebcb67/.mvn/wrapper/maven-wrapper.jar
--------------------------------------------------------------------------------
/.mvn/wrapper/maven-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.6/apache-maven-3.8.6-bin.zip
2 | wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar
3 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 | Auth Basic Template API
3 |
4 |
5 | ## About
6 |
7 | The service provides an example implementation of the Basic Management users with roles, besides include some JUnit test
8 | ideal for begin to practice.
9 |
10 | some technologies used:
11 |
12 | - PostgreSQL
13 | - JWT
14 | - Swagger
15 | - JPA
16 | - Java 19
17 |
18 | ## Contributors
19 |
20 | Contribution and feedback is encouraged and always welcome
21 |
--------------------------------------------------------------------------------
/mvnw:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | # ----------------------------------------------------------------------------
3 | # Licensed to the Apache Software Foundation (ASF) under one
4 | # or more contributor license agreements. See the NOTICE file
5 | # distributed with this work for additional information
6 | # regarding copyright ownership. The ASF licenses this file
7 | # to you under the Apache License, Version 2.0 (the
8 | # "License"); you may not use this file except in compliance
9 | # with the License. You may obtain a copy of the License at
10 | #
11 | # https://www.apache.org/licenses/LICENSE-2.0
12 | #
13 | # Unless required by applicable law or agreed to in writing,
14 | # software distributed under the License is distributed on an
15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | # KIND, either express or implied. See the License for the
17 | # specific language governing permissions and limitations
18 | # under the License.
19 | # ----------------------------------------------------------------------------
20 |
21 | # ----------------------------------------------------------------------------
22 | # Maven Start Up Batch script
23 | #
24 | # Required ENV vars:
25 | # ------------------
26 | # JAVA_HOME - location of a JDK home dir
27 | #
28 | # Optional ENV vars
29 | # -----------------
30 | # M2_HOME - location of maven2's installed home dir
31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven
32 | # e.g. to debug Maven itself, use
33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files
35 | # ----------------------------------------------------------------------------
36 |
37 | if [ -z "$MAVEN_SKIP_RC" ] ; then
38 |
39 | if [ -f /usr/local/etc/mavenrc ] ; then
40 | . /usr/local/etc/mavenrc
41 | fi
42 |
43 | if [ -f /etc/mavenrc ] ; then
44 | . /etc/mavenrc
45 | fi
46 |
47 | if [ -f "$HOME/.mavenrc" ] ; then
48 | . "$HOME/.mavenrc"
49 | fi
50 |
51 | fi
52 |
53 | # OS specific support. $var _must_ be set to either true or false.
54 | cygwin=false;
55 | darwin=false;
56 | mingw=false
57 | case "`uname`" in
58 | CYGWIN*) cygwin=true ;;
59 | MINGW*) mingw=true;;
60 | Darwin*) darwin=true
61 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home
62 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html
63 | if [ -z "$JAVA_HOME" ]; then
64 | if [ -x "/usr/libexec/java_home" ]; then
65 | export JAVA_HOME="`/usr/libexec/java_home`"
66 | else
67 | export JAVA_HOME="/Library/Java/Home"
68 | fi
69 | fi
70 | ;;
71 | esac
72 |
73 | if [ -z "$JAVA_HOME" ] ; then
74 | if [ -r /etc/gentoo-release ] ; then
75 | JAVA_HOME=`java-config --jre-home`
76 | fi
77 | fi
78 |
79 | if [ -z "$M2_HOME" ] ; then
80 | ## resolve links - $0 may be a link to maven's home
81 | PRG="$0"
82 |
83 | # need this for relative symlinks
84 | while [ -h "$PRG" ] ; do
85 | ls=`ls -ld "$PRG"`
86 | link=`expr "$ls" : '.*-> \(.*\)$'`
87 | if expr "$link" : '/.*' > /dev/null; then
88 | PRG="$link"
89 | else
90 | PRG="`dirname "$PRG"`/$link"
91 | fi
92 | done
93 |
94 | saveddir=`pwd`
95 |
96 | M2_HOME=`dirname "$PRG"`/..
97 |
98 | # make it fully qualified
99 | M2_HOME=`cd "$M2_HOME" && pwd`
100 |
101 | cd "$saveddir"
102 | # echo Using m2 at $M2_HOME
103 | fi
104 |
105 | # For Cygwin, ensure paths are in UNIX format before anything is touched
106 | if $cygwin ; then
107 | [ -n "$M2_HOME" ] &&
108 | M2_HOME=`cygpath --unix "$M2_HOME"`
109 | [ -n "$JAVA_HOME" ] &&
110 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
111 | [ -n "$CLASSPATH" ] &&
112 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"`
113 | fi
114 |
115 | # For Mingw, ensure paths are in UNIX format before anything is touched
116 | if $mingw ; then
117 | [ -n "$M2_HOME" ] &&
118 | M2_HOME="`(cd "$M2_HOME"; pwd)`"
119 | [ -n "$JAVA_HOME" ] &&
120 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`"
121 | fi
122 |
123 | if [ -z "$JAVA_HOME" ]; then
124 | javaExecutable="`which javac`"
125 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then
126 | # readlink(1) is not available as standard on Solaris 10.
127 | readLink=`which readlink`
128 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then
129 | if $darwin ; then
130 | javaHome="`dirname \"$javaExecutable\"`"
131 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac"
132 | else
133 | javaExecutable="`readlink -f \"$javaExecutable\"`"
134 | fi
135 | javaHome="`dirname \"$javaExecutable\"`"
136 | javaHome=`expr "$javaHome" : '\(.*\)/bin'`
137 | JAVA_HOME="$javaHome"
138 | export JAVA_HOME
139 | fi
140 | fi
141 | fi
142 |
143 | if [ -z "$JAVACMD" ] ; then
144 | if [ -n "$JAVA_HOME" ] ; then
145 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
146 | # IBM's JDK on AIX uses strange locations for the executables
147 | JAVACMD="$JAVA_HOME/jre/sh/java"
148 | else
149 | JAVACMD="$JAVA_HOME/bin/java"
150 | fi
151 | else
152 | JAVACMD="`\\unset -f command; \\command -v java`"
153 | fi
154 | fi
155 |
156 | if [ ! -x "$JAVACMD" ] ; then
157 | echo "Error: JAVA_HOME is not defined correctly." >&2
158 | echo " We cannot execute $JAVACMD" >&2
159 | exit 1
160 | fi
161 |
162 | if [ -z "$JAVA_HOME" ] ; then
163 | echo "Warning: JAVA_HOME environment variable is not set."
164 | fi
165 |
166 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher
167 |
168 | # traverses directory structure from process work directory to filesystem root
169 | # first directory with .mvn subdirectory is considered project base directory
170 | find_maven_basedir() {
171 |
172 | if [ -z "$1" ]
173 | then
174 | echo "Path not specified to find_maven_basedir"
175 | return 1
176 | fi
177 |
178 | basedir="$1"
179 | wdir="$1"
180 | while [ "$wdir" != '/' ] ; do
181 | if [ -d "$wdir"/.mvn ] ; then
182 | basedir=$wdir
183 | break
184 | fi
185 | # workaround for JBEAP-8937 (on Solaris 10/Sparc)
186 | if [ -d "${wdir}" ]; then
187 | wdir=`cd "$wdir/.."; pwd`
188 | fi
189 | # end of workaround
190 | done
191 | echo "${basedir}"
192 | }
193 |
194 | # concatenates all lines of a file
195 | concat_lines() {
196 | if [ -f "$1" ]; then
197 | echo "$(tr -s '\n' ' ' < "$1")"
198 | fi
199 | }
200 |
201 | BASE_DIR=`find_maven_basedir "$(pwd)"`
202 | if [ -z "$BASE_DIR" ]; then
203 | exit 1;
204 | fi
205 |
206 | ##########################################################################################
207 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
208 | # This allows using the maven wrapper in projects that prohibit checking in binary data.
209 | ##########################################################################################
210 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then
211 | if [ "$MVNW_VERBOSE" = true ]; then
212 | echo "Found .mvn/wrapper/maven-wrapper.jar"
213 | fi
214 | else
215 | if [ "$MVNW_VERBOSE" = true ]; then
216 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..."
217 | fi
218 | if [ -n "$MVNW_REPOURL" ]; then
219 | jarUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar"
220 | else
221 | jarUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar"
222 | fi
223 | while IFS="=" read key value; do
224 | case "$key" in (wrapperUrl) jarUrl="$value"; break ;;
225 | esac
226 | done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties"
227 | if [ "$MVNW_VERBOSE" = true ]; then
228 | echo "Downloading from: $jarUrl"
229 | fi
230 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar"
231 | if $cygwin; then
232 | wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"`
233 | fi
234 |
235 | if command -v wget > /dev/null; then
236 | if [ "$MVNW_VERBOSE" = true ]; then
237 | echo "Found wget ... using wget"
238 | fi
239 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
240 | wget "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath"
241 | else
242 | wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath"
243 | fi
244 | elif command -v curl > /dev/null; then
245 | if [ "$MVNW_VERBOSE" = true ]; then
246 | echo "Found curl ... using curl"
247 | fi
248 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
249 | curl -o "$wrapperJarPath" "$jarUrl" -f
250 | else
251 | curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f
252 | fi
253 |
254 | else
255 | if [ "$MVNW_VERBOSE" = true ]; then
256 | echo "Falling back to using Java to download"
257 | fi
258 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java"
259 | # For Cygwin, switch paths to Windows format before running javac
260 | if $cygwin; then
261 | javaClass=`cygpath --path --windows "$javaClass"`
262 | fi
263 | if [ -e "$javaClass" ]; then
264 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
265 | if [ "$MVNW_VERBOSE" = true ]; then
266 | echo " - Compiling MavenWrapperDownloader.java ..."
267 | fi
268 | # Compiling the Java class
269 | ("$JAVA_HOME/bin/javac" "$javaClass")
270 | fi
271 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
272 | # Running the downloader
273 | if [ "$MVNW_VERBOSE" = true ]; then
274 | echo " - Running MavenWrapperDownloader.java ..."
275 | fi
276 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR")
277 | fi
278 | fi
279 | fi
280 | fi
281 | ##########################################################################################
282 | # End of extension
283 | ##########################################################################################
284 |
285 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}
286 | if [ "$MVNW_VERBOSE" = true ]; then
287 | echo $MAVEN_PROJECTBASEDIR
288 | fi
289 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS"
290 |
291 | # For Cygwin, switch paths to Windows format before running java
292 | if $cygwin; then
293 | [ -n "$M2_HOME" ] &&
294 | M2_HOME=`cygpath --path --windows "$M2_HOME"`
295 | [ -n "$JAVA_HOME" ] &&
296 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"`
297 | [ -n "$CLASSPATH" ] &&
298 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"`
299 | [ -n "$MAVEN_PROJECTBASEDIR" ] &&
300 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"`
301 | fi
302 |
303 | # Provide a "standardized" way to retrieve the CLI args that will
304 | # work with both Windows and non-Windows executions.
305 | MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@"
306 | export MAVEN_CMD_LINE_ARGS
307 |
308 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
309 |
310 | exec "$JAVACMD" \
311 | $MAVEN_OPTS \
312 | $MAVEN_DEBUG_OPTS \
313 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \
314 | "-Dmaven.home=${M2_HOME}" \
315 | "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \
316 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@"
317 |
--------------------------------------------------------------------------------
/mvnw.cmd:
--------------------------------------------------------------------------------
1 | @REM ----------------------------------------------------------------------------
2 | @REM Licensed to the Apache Software Foundation (ASF) under one
3 | @REM or more contributor license agreements. See the NOTICE file
4 | @REM distributed with this work for additional information
5 | @REM regarding copyright ownership. The ASF licenses this file
6 | @REM to you under the Apache License, Version 2.0 (the
7 | @REM "License"); you may not use this file except in compliance
8 | @REM with the License. You may obtain a copy of the License at
9 | @REM
10 | @REM https://www.apache.org/licenses/LICENSE-2.0
11 | @REM
12 | @REM Unless required by applicable law or agreed to in writing,
13 | @REM software distributed under the License is distributed on an
14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | @REM KIND, either express or implied. See the License for the
16 | @REM specific language governing permissions and limitations
17 | @REM under the License.
18 | @REM ----------------------------------------------------------------------------
19 |
20 | @REM ----------------------------------------------------------------------------
21 | @REM Maven Start Up Batch script
22 | @REM
23 | @REM Required ENV vars:
24 | @REM JAVA_HOME - location of a JDK home dir
25 | @REM
26 | @REM Optional ENV vars
27 | @REM M2_HOME - location of maven2's installed home dir
28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands
29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending
30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven
31 | @REM e.g. to debug Maven itself, use
32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files
34 | @REM ----------------------------------------------------------------------------
35 |
36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
37 | @echo off
38 | @REM set title of command window
39 | title %0
40 | @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on'
41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO%
42 |
43 | @REM set %HOME% to equivalent of $HOME
44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%")
45 |
46 | @REM Execute a user defined script before this one
47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre
48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending
49 | if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %*
50 | if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %*
51 | :skipRcPre
52 |
53 | @setlocal
54 |
55 | set ERROR_CODE=0
56 |
57 | @REM To isolate internal variables from possible post scripts, we use another setlocal
58 | @setlocal
59 |
60 | @REM ==== START VALIDATION ====
61 | if not "%JAVA_HOME%" == "" goto OkJHome
62 |
63 | echo.
64 | echo Error: JAVA_HOME not found in your environment. >&2
65 | echo Please set the JAVA_HOME variable in your environment to match the >&2
66 | echo location of your Java installation. >&2
67 | echo.
68 | goto error
69 |
70 | :OkJHome
71 | if exist "%JAVA_HOME%\bin\java.exe" goto init
72 |
73 | echo.
74 | echo Error: JAVA_HOME is set to an invalid directory. >&2
75 | echo JAVA_HOME = "%JAVA_HOME%" >&2
76 | echo Please set the JAVA_HOME variable in your environment to match the >&2
77 | echo location of your Java installation. >&2
78 | echo.
79 | goto error
80 |
81 | @REM ==== END VALIDATION ====
82 |
83 | :init
84 |
85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn".
86 | @REM Fallback to current working directory if not found.
87 |
88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR%
89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir
90 |
91 | set EXEC_DIR=%CD%
92 | set WDIR=%EXEC_DIR%
93 | :findBaseDir
94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound
95 | cd ..
96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound
97 | set WDIR=%CD%
98 | goto findBaseDir
99 |
100 | :baseDirFound
101 | set MAVEN_PROJECTBASEDIR=%WDIR%
102 | cd "%EXEC_DIR%"
103 | goto endDetectBaseDir
104 |
105 | :baseDirNotFound
106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR%
107 | cd "%EXEC_DIR%"
108 |
109 | :endDetectBaseDir
110 |
111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig
112 |
113 | @setlocal EnableExtensions EnableDelayedExpansion
114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a
115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS%
116 |
117 | :endReadAdditionalConfig
118 |
119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe"
120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar"
121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
122 |
123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar"
124 |
125 | FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO (
126 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B
127 | )
128 |
129 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
130 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data.
131 | if exist %WRAPPER_JAR% (
132 | if "%MVNW_VERBOSE%" == "true" (
133 | echo Found %WRAPPER_JAR%
134 | )
135 | ) else (
136 | if not "%MVNW_REPOURL%" == "" (
137 | SET DOWNLOAD_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar"
138 | )
139 | if "%MVNW_VERBOSE%" == "true" (
140 | echo Couldn't find %WRAPPER_JAR%, downloading it ...
141 | echo Downloading from: %DOWNLOAD_URL%
142 | )
143 |
144 | powershell -Command "&{"^
145 | "$webclient = new-object System.Net.WebClient;"^
146 | "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^
147 | "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^
148 | "}"^
149 | "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^
150 | "}"
151 | if "%MVNW_VERBOSE%" == "true" (
152 | echo Finished downloading %WRAPPER_JAR%
153 | )
154 | )
155 | @REM End of extension
156 |
157 | @REM Provide a "standardized" way to retrieve the CLI args that will
158 | @REM work with both Windows and non-Windows executions.
159 | set MAVEN_CMD_LINE_ARGS=%*
160 |
161 | %MAVEN_JAVA_EXE% ^
162 | %JVM_CONFIG_MAVEN_PROPS% ^
163 | %MAVEN_OPTS% ^
164 | %MAVEN_DEBUG_OPTS% ^
165 | -classpath %WRAPPER_JAR% ^
166 | "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^
167 | %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %*
168 | if ERRORLEVEL 1 goto error
169 | goto end
170 |
171 | :error
172 | set ERROR_CODE=1
173 |
174 | :end
175 | @endlocal & set ERROR_CODE=%ERROR_CODE%
176 |
177 | if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost
178 | @REM check for post script, once with legacy .bat ending and once with .cmd ending
179 | if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat"
180 | if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd"
181 | :skipRcPost
182 |
183 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on'
184 | if "%MAVEN_BATCH_PAUSE%"=="on" pause
185 |
186 | if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE%
187 |
188 | cmd /C exit /B %ERROR_CODE%
189 |
--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
4 | 4.0.0
5 |
6 | org.springframework.boot
7 | spring-boot-starter-parent
8 | 2.7.5
9 |
10 |
11 | com.template
12 | auth
13 | 0.0.1-SNAPSHOT
14 | auth
15 | Project for manage auth with jwt
16 |
17 | 17
18 |
19 |
20 |
21 | org.springframework.boot
22 | spring-boot-starter-data-jpa
23 |
24 |
25 | org.springframework.boot
26 | spring-boot-starter-security
27 |
28 |
29 | org.springframework.boot
30 | spring-boot-starter-web
31 |
32 |
33 | io.jsonwebtoken
34 | jjwt
35 | 0.9.1
36 |
37 |
38 |
39 | org.postgresql
40 | postgresql
41 | runtime
42 |
43 |
44 | org.projectlombok
45 | lombok
46 | true
47 |
48 |
49 | org.springframework.boot
50 | spring-boot-starter-test
51 | test
52 |
53 |
54 | org.springdoc
55 | springdoc-openapi-ui
56 | 1.6.12
57 |
58 |
59 | org.springframework.boot
60 | spring-boot-starter-validation
61 |
62 |
63 | org.springframework.boot
64 | spring-boot-starter-security
65 |
66 |
67 | io.jsonwebtoken
68 | jjwt-api
69 | 0.11.5
70 |
71 |
72 |
73 | io.jsonwebtoken
74 | jjwt
75 | 0.9.1
76 |
77 |
78 |
79 |
80 |
81 |
82 |
83 | org.springframework.boot
84 | spring-boot-maven-plugin
85 |
86 |
87 |
88 | org.projectlombok
89 | lombok
90 |
91 |
92 |
93 |
94 |
95 |
96 |
97 |
98 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/AuthApplication.java:
--------------------------------------------------------------------------------
1 | package com.template.auth;
2 |
3 | import org.springframework.boot.SpringApplication;
4 | import org.springframework.boot.autoconfigure.SpringBootApplication;
5 |
6 | @SpringBootApplication
7 | public class AuthApplication {
8 |
9 | public static void main(String[] args) {
10 | SpringApplication.run(AuthApplication.class, args);
11 | }
12 |
13 | }
14 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/controllers/AdviceController.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.controllers;
2 |
3 | import com.template.auth.dto.ErroDto;
4 | import com.template.auth.exceptions.RequestException;
5 | import org.slf4j.Logger;
6 | import org.slf4j.LoggerFactory;
7 | import org.springframework.http.HttpStatus;
8 | import org.springframework.http.ResponseEntity;
9 | import org.springframework.security.access.AccessDeniedException;
10 | import org.springframework.web.bind.MethodArgumentNotValidException;
11 | import org.springframework.web.bind.annotation.ExceptionHandler;
12 | import org.springframework.web.bind.annotation.RestControllerAdvice;
13 |
14 | import java.util.ArrayList;
15 | import java.util.List;
16 |
17 |
18 | @RestControllerAdvice
19 | public class AdviceController {
20 | Logger logger = LoggerFactory.getLogger(AdviceController.class);
21 | @ExceptionHandler(value = RuntimeException.class)
22 | public ResponseEntity runtimeExceptionHandler(RuntimeException ex){
23 | logger.error(ex.getMessage());
24 | ErroDto error = ErroDto.builder().code("P-500").message("Ups: a error has ocurred").build();
25 | return new ResponseEntity<>(error, HttpStatus.INTERNAL_SERVER_ERROR);
26 | }
27 | @ExceptionHandler(value = RequestException.class)
28 | public ResponseEntity requestExceptionHandler(RequestException ex){
29 | ErroDto error = ErroDto.builder().code(ex.getCode()).message(ex.getMessage()).build();
30 | return new ResponseEntity<>(error, ex.getHttpStatus());
31 | }
32 | @ExceptionHandler(value = AccessDeniedException.class)
33 | public ResponseEntity accessDeniedExceptionHandler(AccessDeniedException ex){
34 | ErroDto error = ErroDto.builder().code("P-403").message(ex.getMessage()).build();
35 | return new ResponseEntity<>(error, HttpStatus.FORBIDDEN);
36 | }
37 | @ExceptionHandler(value = MethodArgumentNotValidException.class)
38 | public ResponseEntity> methodArgumentNotValid(MethodArgumentNotValidException ex){
39 | List errors = new ArrayList<>();
40 | if (ex.getBindingResult().hasErrors()) {
41 | ex.getBindingResult().getFieldErrors().forEach(error -> {
42 | errors.add(ErroDto.builder().message(error.getField() + " " + error.getDefaultMessage()).code("P-400").build());
43 | });
44 | }
45 | return ResponseEntity.unprocessableEntity().body(errors);
46 | }
47 | }
48 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/controllers/AuthController.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.controllers;
2 |
3 | import com.template.auth.dto.LoginRequest;
4 | import com.template.auth.dto.TokenResponse;
5 | import com.template.auth.exceptions.RequestException;
6 | import com.template.auth.model.MyUserPrincipal;
7 | import com.template.auth.security.JwtUtils;
8 | import com.template.auth.services.UserDetailService;
9 | import lombok.RequiredArgsConstructor;
10 | import org.springframework.http.HttpStatus;
11 | import org.springframework.http.ResponseEntity;
12 | import org.springframework.web.bind.annotation.PostMapping;
13 | import org.springframework.web.bind.annotation.RequestBody;
14 | import org.springframework.web.bind.annotation.RequestMapping;
15 | import org.springframework.web.bind.annotation.RestController;
16 |
17 | @RestController
18 | @RequestMapping("/api/v1/auth")
19 | @RequiredArgsConstructor
20 | public class AuthController {
21 | private final JwtUtils jwtUtils;
22 | private final UserDetailService userDetailService;
23 | @PostMapping("/login")
24 | public ResponseEntity authenticate(@RequestBody LoginRequest loginRequest){
25 | final MyUserPrincipal userDetails = userDetailService.loadUserByUsername(loginRequest.getUsername(), loginRequest.getPassword());
26 | if (userDetails != null) {
27 | //TODO add refresh token
28 | return ResponseEntity.ok(jwtUtils.generateToken(userDetails));
29 | }
30 | throw new RequestException(HttpStatus.UNAUTHORIZED,"P-401","bad credentials");
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/controllers/GroupController.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.controllers;
2 |
3 |
4 | import com.template.auth.dto.GroupRequestDto;
5 | import com.template.auth.model.Group;
6 | import com.template.auth.services.GroupService;
7 | import org.springframework.http.HttpStatus;
8 | import org.springframework.http.ResponseEntity;
9 | import org.springframework.web.bind.annotation.*;
10 |
11 | import javax.validation.Valid;
12 | import java.util.List;
13 |
14 | @RestController
15 | @RequestMapping("/api/v1/group")
16 | public class GroupController {
17 | GroupService groupService;
18 | public GroupController(GroupService groupService) {
19 | this.groupService = groupService;
20 | }
21 | @PostMapping("/create")
22 | public ResponseEntity create(@Valid @RequestBody GroupRequestDto group) {
23 | Group newGroup = groupService.addGroupWithRole(group);
24 | return new ResponseEntity<>(newGroup, HttpStatus.OK);
25 | }
26 | @GetMapping("/")
27 | public ResponseEntity> getGroups() {
28 | List groups = groupService.getAll();
29 | return new ResponseEntity<>(groups, HttpStatus.OK);
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/controllers/RoleController.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.controllers;
2 |
3 |
4 | import com.template.auth.model.Role;
5 | import com.template.auth.services.RoleService;
6 | import org.springframework.http.HttpStatus;
7 | import org.springframework.http.ResponseEntity;
8 | import org.springframework.security.access.prepost.PreAuthorize;
9 | import org.springframework.web.bind.annotation.*;
10 |
11 | import javax.validation.Valid;
12 | import java.util.List;
13 |
14 | @RestController
15 | @RequestMapping("/api/v1/role")
16 | public class RoleController {
17 | RoleService roleService;
18 | public RoleController(RoleService roleService) {
19 | this.roleService = roleService;
20 | }
21 | @PostMapping("/create")
22 | public ResponseEntity create(@Valid @RequestBody Role role) {
23 | Role newRole = roleService.save(role);
24 | return new ResponseEntity<>(newRole, HttpStatus.OK);
25 | }
26 | @PreAuthorize("hasRole('ROLE_ROLE_LIST')")
27 | @GetMapping("/")
28 | public ResponseEntity> getRoles() {
29 | List roles = roleService.getAll();
30 | return new ResponseEntity<>(roles, HttpStatus.OK);
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/controllers/UserController.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.controllers;
2 |
3 |
4 | import com.template.auth.dto.UserRequestDto;
5 | import com.template.auth.exceptions.RequestException;
6 | import com.template.auth.model.User;
7 | import com.template.auth.services.UserService;
8 | import org.springframework.http.HttpStatus;
9 | import org.springframework.http.ResponseEntity;
10 | import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
11 | import org.springframework.web.bind.annotation.*;
12 |
13 | import javax.validation.Valid;
14 | import java.util.List;
15 | import java.util.Optional;
16 |
17 | @RestController
18 | @RequestMapping("/api/v1/user")
19 | public class UserController {
20 | private final UserService userService;
21 | public UserController(UserService userService) {
22 | this.userService = userService;
23 | }
24 | @GetMapping(value = "/by-username")
25 | public ResponseEntity findByUsername(@RequestParam(name = "username") String username) {
26 | Optional user = this.userService.findByUsername(username);
27 | if (user.isEmpty()){
28 | throw new RequestException(HttpStatus.NOT_FOUND,"P-400","User not found");
29 | }
30 | return new ResponseEntity<>(user.get(), HttpStatus.OK);
31 | }
32 |
33 | @GetMapping("/")
34 | public ResponseEntity> findAll(){
35 | List users = userService.findAll();
36 | return new ResponseEntity<>(users, HttpStatus.OK);
37 | }
38 |
39 | @PostMapping("/create")
40 | public ResponseEntity create(@Valid @RequestBody UserRequestDto user) {
41 | BCryptPasswordEncoder bCryptPasswordEncoder = new BCryptPasswordEncoder();
42 | String encryptedPass = bCryptPasswordEncoder.encode(user.getPassword());
43 | user.setPassword(encryptedPass);
44 | userService.save(user.toUser());
45 | return new ResponseEntity(user.toUser(), HttpStatus.OK);
46 |
47 | }
48 | }
49 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/dto/ErroDto.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.dto;
2 |
3 | import lombok.Builder;
4 | import lombok.Data;
5 |
6 | @Data
7 | @Builder
8 | public class ErroDto {
9 | private String code;
10 | private String message;
11 | }
12 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/dto/GroupRequestDto.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.dto;
2 |
3 | import com.template.auth.model.Role;
4 | import lombok.Data;
5 |
6 | import java.util.Set;
7 |
8 | @Data
9 | public class GroupRequestDto {
10 | private int id;
11 | private String name;
12 | private Set roles;
13 | }
14 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/dto/LoginRequest.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.dto;
2 |
3 | import lombok.Builder;
4 | import lombok.Getter;
5 | import lombok.Setter;
6 |
7 | @Getter
8 | @Setter
9 | @Builder
10 | public class LoginRequest {
11 | private String username;
12 | private String password;
13 | }
14 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/dto/Message.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.dto;
2 |
3 | import lombok.AllArgsConstructor;
4 | import lombok.Getter;
5 | import lombok.Setter;
6 |
7 | @Getter @Setter @AllArgsConstructor
8 | public class Message {
9 | private String mensaje;
10 | }
11 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/dto/TokenResponse.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.dto;
2 |
3 | import lombok.Builder;
4 | import lombok.Data;
5 |
6 | @Data
7 | @Builder
8 | public class TokenResponse {
9 | private String token;
10 | private String refreshToken;
11 | }
12 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/dto/UserRequestDto.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.dto;
2 |
3 | import com.template.auth.model.Group;
4 | import com.template.auth.model.User;
5 | import lombok.Builder;
6 | import lombok.Data;
7 |
8 | import javax.validation.constraints.Email;
9 | import javax.validation.constraints.NotBlank;
10 | import javax.validation.constraints.Size;
11 | import java.util.HashSet;
12 | import java.util.Set;
13 |
14 | @Data
15 | @Builder
16 | public class UserRequestDto {
17 | @NotBlank(message = "field required")
18 | private String name;
19 | @NotBlank(message = "field required")
20 | private String username;
21 | @NotBlank(message = "field required")
22 | @Email(message = "email required")
23 | private String email;
24 | @NotBlank(message = "field required")
25 | @Size(min = 8, message = "password must contain a minimum of 8 characters")
26 | @Size(max = 20, message = "password must contain a max of 20 characters")
27 | private String password;
28 | private Set groups = new HashSet<>();
29 |
30 | public User toUser(){
31 | return User.builder().name(name).username(username).email(email).password(password).groups(groups).build();
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/exceptions/RequestException.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.exceptions;
2 |
3 | import lombok.Data;
4 | import org.springframework.http.HttpStatus;
5 |
6 | @Data
7 | public class RequestException extends RuntimeException{
8 | private String code;
9 | private HttpStatus httpStatus;
10 | public RequestException(HttpStatus httpStatus, String code, String message){
11 | super(message);
12 | this.code = code;
13 | this.httpStatus = httpStatus;
14 | }
15 | }
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/interfaces/UserInterface.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.interfaces;
2 |
3 | import com.template.auth.model.User;
4 | import org.springframework.http.ResponseEntity;
5 |
6 | public interface UserInterface {
7 | ResponseEntity> findByUsername(String username);
8 | ResponseEntity> create(User user);
9 | }
10 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/model/Group.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.model;
2 |
3 | import com.fasterxml.jackson.annotation.JsonIgnore;
4 | import com.sun.istack.NotNull;
5 | import lombok.Getter;
6 | import lombok.NoArgsConstructor;
7 | import lombok.Setter;
8 |
9 | import javax.persistence.*;
10 | import java.util.HashSet;
11 | import java.util.Set;
12 |
13 | @Entity
14 | @Table(name = "auth_group", schema = "public")
15 | @Getter @Setter @NoArgsConstructor
16 | public class Group {
17 | @Id
18 | @GeneratedValue(strategy = GenerationType.IDENTITY)
19 | @Column(name = "group_id")
20 | private int id;
21 | @NotNull
22 | private String name;
23 |
24 | @ManyToMany(fetch = FetchType.LAZY,cascade = {CascadeType.MERGE,CascadeType.PERSIST,CascadeType.MERGE, CascadeType.REFRESH})
25 | @JoinTable(name = "auth_role_group", joinColumns = @JoinColumn(name = "group_id"), inverseJoinColumns = @JoinColumn(name = "role_id"))
26 | private Set roles = new HashSet<>();
27 |
28 | @JsonIgnore
29 | @ManyToMany(mappedBy = "groups")
30 | private Set users = new HashSet<>();
31 |
32 | public void addUser(User user){
33 | this.getUsers().add(user);
34 | }
35 |
36 | }
37 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/model/MyUserPrincipal.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.model;
2 |
3 | import lombok.RequiredArgsConstructor;
4 | import org.springframework.security.core.GrantedAuthority;
5 | import org.springframework.security.core.authority.SimpleGrantedAuthority;
6 | import org.springframework.security.core.userdetails.UserDetails;
7 |
8 | import java.util.Collection;
9 | import java.util.List;
10 | import java.util.stream.Collectors;
11 |
12 | @RequiredArgsConstructor
13 | public class MyUserPrincipal implements UserDetails {
14 | private User user;
15 |
16 | public MyUserPrincipal(User user){
17 | this.user = user;
18 | };
19 |
20 | @Override
21 | public Collection extends GrantedAuthority> getAuthorities() {
22 | return user.getRoles().stream().map(rol -> new SimpleGrantedAuthority(rol.getName())).collect(Collectors.toList());
23 | }
24 | public List getRoles(){
25 | return this.user.get_roles();
26 | }
27 |
28 | @Override
29 | public String getPassword() {
30 | return user.getPassword();
31 | }
32 |
33 | @Override
34 | public String getUsername() {
35 | return user.getUsername();
36 | }
37 |
38 | @Override
39 | public boolean isAccountNonExpired() {
40 | return true;
41 | }
42 |
43 | @Override
44 | public boolean isAccountNonLocked() {
45 | return true;
46 | }
47 |
48 | @Override
49 | public boolean isCredentialsNonExpired() {
50 | return false;
51 | }
52 |
53 | @Override
54 | public boolean isEnabled() {
55 | return true;
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/model/Role.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.model;
2 |
3 | import com.fasterxml.jackson.annotation.JsonIgnore;
4 | import com.sun.istack.NotNull;
5 | import lombok.Getter;
6 | import lombok.NoArgsConstructor;
7 | import lombok.Setter;
8 |
9 | import javax.persistence.*;
10 | import java.util.HashSet;
11 | import java.util.Set;
12 |
13 |
14 | @Entity
15 | @Table(name = "auth_role", schema = "public")
16 | @Getter
17 | @Setter
18 | @NoArgsConstructor
19 | public class Role {
20 | @Id
21 | @GeneratedValue(strategy = GenerationType.IDENTITY)
22 | @Column(name = "role_id")
23 | private int id;
24 | @NotNull
25 | private String name;
26 | @ManyToMany(mappedBy = "roles")
27 | @JsonIgnore
28 | private Set groups = new HashSet<>();
29 |
30 | public void addGroup(Group group){
31 | this.getGroups().add(group);
32 | }
33 |
34 | }
35 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/model/User.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.model;
2 |
3 |
4 | import com.sun.istack.NotNull;
5 | import lombok.AllArgsConstructor;
6 | import lombok.Builder;
7 | import lombok.Data;
8 | import lombok.NoArgsConstructor;
9 |
10 | import javax.persistence.*;
11 | import java.util.HashSet;
12 | import java.util.List;
13 | import java.util.Set;
14 |
15 |
16 | @Entity
17 | @Table(name = "auth_user", schema = "public")
18 | @Data @Builder @NoArgsConstructor @AllArgsConstructor
19 | public class User {
20 | @Id
21 | @GeneratedValue(strategy = GenerationType.IDENTITY)
22 | private int id;
23 | @NotNull
24 | private String name;
25 | @Column(unique = true)
26 | private String username;
27 | @NotNull
28 | private String email;
29 | @NotNull
30 | private String password;
31 | @ManyToMany(fetch = FetchType.LAZY,cascade = {CascadeType.MERGE,CascadeType.PERSIST, CascadeType.REFRESH})
32 | @JoinTable(name = "auth_group_user", joinColumns = @JoinColumn(name = "user_id"), inverseJoinColumns = @JoinColumn(name = "group_id"))
33 | private Set groups = new HashSet<>();
34 | @Transient
35 | private List _roles;
36 |
37 | public void setRoles(List roles){
38 | _roles = roles;
39 | }
40 | public List getRoles(){
41 | return this._roles;
42 | }
43 |
44 | }
45 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/repository/GroupRepository.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.repository;
2 |
3 | import com.template.auth.model.Group;
4 | import org.springframework.data.jpa.repository.JpaRepository;
5 | import org.springframework.stereotype.Service;
6 |
7 | import java.util.Optional;
8 |
9 | @Service
10 | public interface GroupRepository extends JpaRepository {
11 | Optional findByName(String name);
12 | }
13 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/repository/RoleRepository.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.repository;
2 |
3 | import com.template.auth.model.Role;
4 | import org.springframework.data.jpa.repository.JpaRepository;
5 | import org.springframework.data.jpa.repository.Query;
6 | import org.springframework.stereotype.Service;
7 |
8 | import java.util.List;
9 | import java.util.Optional;
10 |
11 | @Service
12 | public interface RoleRepository extends JpaRepository {
13 | Optional findByName(String role);
14 |
15 | Role findById(int id);
16 |
17 | @Query(value = "SELECT * FROM auth_role ar " +
18 | "INNER JOIN auth_role_group arg ON arg.role_id =ar.role_id " +
19 | "INNER JOIN auth_group_user agu ON agu.group_id = arg.group_id " +
20 | "WHERE agu.user_id = :userId", nativeQuery = true)
21 | List findAllByUser(int userId);
22 | }
23 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/repository/UserRepository.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.repository;
2 |
3 | import com.template.auth.model.User;
4 | import org.springframework.data.jpa.repository.JpaRepository;
5 | import org.springframework.stereotype.Repository;
6 |
7 | import java.util.Optional;
8 |
9 | @Repository
10 | public interface UserRepository extends JpaRepository {
11 | Optional findByUsername(String username);
12 | }
13 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/security/JwtAuthFilter.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.security;
2 |
3 | import com.template.auth.services.UserDetailService;
4 | import lombok.RequiredArgsConstructor;
5 | import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
6 | import org.springframework.security.core.context.SecurityContextHolder;
7 | import org.springframework.security.core.userdetails.UserDetails;
8 | import org.springframework.security.web.authentication.WebAuthenticationDetailsSource;
9 | import org.springframework.stereotype.Component;
10 | import org.springframework.web.filter.OncePerRequestFilter;
11 |
12 | import javax.servlet.FilterChain;
13 | import javax.servlet.ServletException;
14 | import javax.servlet.http.HttpServletRequest;
15 | import javax.servlet.http.HttpServletResponse;
16 | import java.io.IOException;
17 |
18 | import static org.springframework.http.HttpHeaders.AUTHORIZATION;
19 | @Component
20 | @RequiredArgsConstructor
21 | public class JwtAuthFilter extends OncePerRequestFilter {
22 | private final JwtUtils jwtUtils;
23 | private final UserDetailService userDetailsService;
24 | @Override
25 | protected void doFilterInternal(HttpServletRequest request,
26 | HttpServletResponse response,
27 | FilterChain filterChain) throws ServletException, IOException {
28 | final String authHeader = request.getHeader(AUTHORIZATION);
29 | final String userEmail;
30 | final String jwtToken;
31 |
32 | if (authHeader == null || !authHeader.startsWith("Bearer")){
33 | filterChain.doFilter(request,response);
34 | return;
35 | }
36 | jwtToken = authHeader.substring(7);
37 | userEmail = jwtUtils.extractUsername(jwtToken);
38 | if (userEmail != null && SecurityContextHolder.getContext().getAuthentication() == null){
39 | UserDetails userDetails = userDetailsService.loadUserByUsername(userEmail);
40 | if (jwtUtils.isValidToken(jwtToken,userDetails)){
41 | UsernamePasswordAuthenticationToken authToken = new UsernamePasswordAuthenticationToken(
42 | userDetails,null,userDetails.getAuthorities()
43 | );
44 | authToken.setDetails(new WebAuthenticationDetailsSource().buildDetails(request));
45 | SecurityContextHolder.getContext().setAuthentication(authToken);
46 | }
47 | }
48 | filterChain.doFilter(request,response);
49 |
50 | }
51 | }
52 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/security/JwtUtils.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.security;
2 |
3 | import com.template.auth.dto.TokenResponse;
4 | import io.jsonwebtoken.Claims;
5 | import io.jsonwebtoken.Jwts;
6 | import io.jsonwebtoken.SignatureAlgorithm;
7 | import org.springframework.security.core.userdetails.UserDetails;
8 | import org.springframework.stereotype.Component;
9 |
10 | import java.util.Date;
11 | import java.util.HashMap;
12 | import java.util.Map;
13 | import java.util.concurrent.TimeUnit;
14 | import java.util.function.Function;
15 |
16 | @Component
17 | public class JwtUtils {
18 | //TODO add vars to properties file
19 | private String jwtSigningKey = "secretclave";
20 |
21 | public String extractUsername(String token){
22 | return extractClaim(token, Claims::getSubject);
23 | }
24 |
25 | public Date extractExpiration(String token) {return extractClaim(token,Claims::getExpiration);}
26 |
27 | public boolean hasClaim(String token, String claimName){
28 | final Claims claims = extractAllClaims(token);
29 | return claims.get(claimName) != null;
30 | }
31 | public TokenResponse generateToken(UserDetails userDetails){
32 | Map claims = new HashMap<>();
33 | //TODO in claims we can add extra user info
34 | String token= createToken(claims,userDetails);
35 | return TokenResponse.builder().token(token).build();
36 | }
37 |
38 | private Claims extractAllClaims(String token) {
39 | return Jwts.parser().setSigningKey(jwtSigningKey).parseClaimsJws(token).getBody();
40 | }
41 |
42 | public String createToken(Map claims, UserDetails userDetails){
43 | return Jwts.builder().setClaims(claims)
44 | .setSubject(userDetails.getUsername())
45 | .claim("authorities",userDetails.getAuthorities())
46 | .setIssuedAt(new Date(System.currentTimeMillis()))
47 | .setExpiration(new Date(System.currentTimeMillis()+ TimeUnit.HOURS.toMillis(24)))
48 | .signWith(SignatureAlgorithm.HS256,jwtSigningKey).compact();
49 | }
50 | public boolean isValidToken(String token, UserDetails userDetails){
51 | final String username = extractUsername(token);
52 | return (username.equals(userDetails.getUsername()) && !isTokenExpired(token));
53 | }
54 |
55 | private boolean isTokenExpired(String token) {
56 | return extractExpiration(token).before(new Date());
57 | }
58 |
59 | private T extractClaim(String token, Function claimsResolver) {
60 | final Claims claims = extractAllClaims(token);
61 | return claimsResolver.apply(claims);
62 | }
63 | }
64 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/security/SecurityConfig.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.security;
2 |
3 | import com.template.auth.services.UserDetailService;
4 | import lombok.RequiredArgsConstructor;
5 | import org.springframework.context.annotation.Bean;
6 | import org.springframework.context.annotation.Configuration;
7 | import org.springframework.security.authentication.AuthenticationManager;
8 | import org.springframework.security.authentication.AuthenticationProvider;
9 | import org.springframework.security.authentication.dao.DaoAuthenticationProvider;
10 | import org.springframework.security.config.annotation.authentication.configuration.AuthenticationConfiguration;
11 | import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity;
12 | import org.springframework.security.config.annotation.web.builders.HttpSecurity;
13 | import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
14 | import org.springframework.security.config.http.SessionCreationPolicy;
15 | import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
16 | import org.springframework.security.crypto.password.PasswordEncoder;
17 | import org.springframework.security.web.SecurityFilterChain;
18 | import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
19 | import org.springframework.web.cors.CorsConfiguration;
20 | import org.springframework.web.cors.CorsConfigurationSource;
21 |
22 | import javax.servlet.http.HttpServletRequest;
23 | import java.util.Collections;
24 |
25 | @Configuration
26 | @EnableWebSecurity
27 | @EnableGlobalMethodSecurity(prePostEnabled = true,
28 | securedEnabled = true,
29 | jsr250Enabled = true)
30 | @RequiredArgsConstructor
31 | public class SecurityConfig {
32 | private final JwtAuthFilter jwtAuthFilter;
33 | private final UserDetailService userDetailService;
34 |
35 | @Bean
36 | public SecurityFilterChain securityFilterChain(HttpSecurity httpSecurity) throws Exception {
37 | return httpSecurity
38 | .csrf().disable()
39 | .authorizeRequests()
40 | .antMatchers("/**/auth/**").permitAll()
41 | .anyRequest()
42 | .authenticated()
43 | .and()
44 | .cors().configurationSource(new CorsConfigurationSource() {
45 | // TODO custom class and limit origin
46 | @Override
47 | public CorsConfiguration getCorsConfiguration(HttpServletRequest request) {
48 | CorsConfiguration config = new CorsConfiguration();
49 | config.setAllowedHeaders(Collections.singletonList("*"));
50 | config.setAllowedMethods(Collections.singletonList("*"));
51 | config.addAllowedOrigin("*");
52 | return config;
53 | }
54 | })
55 | .and()
56 | .sessionManagement()
57 | .sessionCreationPolicy(SessionCreationPolicy.STATELESS)
58 | .and()
59 | .authenticationProvider(authenticationProvider())
60 | .addFilterBefore(jwtAuthFilter, UsernamePasswordAuthenticationFilter.class)
61 | .httpBasic()
62 | .and()
63 | .build();
64 | }
65 | @Bean
66 | public AuthenticationManager authenticationManager(AuthenticationConfiguration configuration) throws Exception{
67 | return configuration.getAuthenticationManager();
68 | }
69 |
70 |
71 | @Bean
72 | public AuthenticationProvider authenticationProvider() {
73 | final DaoAuthenticationProvider authenticationProvider = new DaoAuthenticationProvider();
74 | authenticationProvider.setUserDetailsService(userDetailService);
75 | authenticationProvider.setPasswordEncoder(passwordEncoder());
76 | return authenticationProvider;
77 |
78 | }
79 | @Bean
80 | public PasswordEncoder passwordEncoder() {
81 | return new BCryptPasswordEncoder();
82 | }
83 |
84 | }
85 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/services/GroupService.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.services;
2 |
3 | import com.template.auth.dto.GroupRequestDto;
4 | import com.template.auth.exceptions.RequestException;
5 | import com.template.auth.model.Group;
6 | import com.template.auth.model.Role;
7 | import com.template.auth.repository.GroupRepository;
8 | import com.template.auth.repository.RoleRepository;
9 | import org.springframework.http.HttpStatus;
10 | import org.springframework.stereotype.Service;
11 |
12 | import java.util.List;
13 | import java.util.Optional;
14 | import java.util.stream.Collectors;
15 |
16 | @Service
17 | public class GroupService {
18 |
19 | private final GroupRepository groupRepository;
20 | private final RoleRepository roleRepository;
21 | public GroupService(GroupRepository groupRepository, RoleRepository roleRepository) {
22 | this.groupRepository = groupRepository;
23 | this.roleRepository = roleRepository;
24 | }
25 | public Optional findByname(String group){
26 | return groupRepository.findByName(group);
27 | }
28 | public Group save(Group group){
29 | return groupRepository.save(group);
30 | }
31 |
32 | public Group addGroupWithRole(GroupRequestDto groupRequest){
33 | Optional prevGroup = groupRepository.findByName(groupRequest.getName().toUpperCase());
34 | if (prevGroup.isPresent()) {
35 | throw new RequestException(HttpStatus.CONFLICT, "p-409", "Group already exists");
36 | }
37 | Group group = new Group();
38 | group.setId(group.getId());
39 | group.setName(groupRequest.getName());
40 | group.setRoles(groupRequest.getRoles()
41 | .stream()
42 | .map(role -> {
43 | Role rrole = role;
44 | if (rrole.getId() > 0){
45 | rrole = roleRepository.findById(rrole.getId());
46 | }
47 | rrole.addGroup(group);
48 | return rrole;
49 | }).collect(Collectors.toSet()));
50 | return groupRepository.save(group);
51 |
52 | }
53 |
54 | public List getAll() {
55 | return groupRepository.findAll();
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/services/RoleService.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.services;
2 |
3 | import com.template.auth.exceptions.RequestException;
4 | import com.template.auth.model.Role;
5 | import com.template.auth.repository.RoleRepository;
6 | import org.springframework.http.HttpStatus;
7 | import org.springframework.stereotype.Service;
8 |
9 | import java.util.List;
10 | import java.util.Optional;
11 |
12 | @Service
13 | public class RoleService {
14 | private final RoleRepository roleRepository;
15 | public RoleService(RoleRepository roleRepository) {
16 | this.roleRepository = roleRepository;
17 | }
18 | public Optional findByname(String role){
19 | return roleRepository.findByName(role);
20 | }
21 | public Role save(Role role){
22 | Optional prevRole = roleRepository.findByName(role.getName().toUpperCase());
23 | if (prevRole.isPresent()) {
24 | throw new RequestException(HttpStatus.CONFLICT, "p-409", "Role already exists");
25 | }
26 | role.setName(role.getName().toUpperCase());
27 | return roleRepository.save(role);
28 | }
29 |
30 | public List getAll() {
31 | return roleRepository.findAll();
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/services/UserDetailService.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.services;
2 |
3 | import com.template.auth.exceptions.RequestException;
4 | import com.template.auth.model.MyUserPrincipal;
5 | import com.template.auth.model.Role;
6 | import com.template.auth.model.User;
7 | import com.template.auth.repository.RoleRepository;
8 | import com.template.auth.repository.UserRepository;
9 | import lombok.RequiredArgsConstructor;
10 | import org.springframework.http.HttpStatus;
11 | import org.springframework.security.core.userdetails.UserDetails;
12 | import org.springframework.security.core.userdetails.UserDetailsService;
13 | import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
14 | import org.springframework.stereotype.Service;
15 |
16 | import java.util.List;
17 | import java.util.Optional;
18 |
19 | @Service
20 | @RequiredArgsConstructor
21 | public class UserDetailService implements UserDetailsService {
22 | private final UserRepository userRepository;
23 | private final RoleRepository roleRepository;
24 |
25 | @Override
26 | public UserDetails loadUserByUsername(String username) {
27 | Optional userOptional = userRepository.findByUsername(username);
28 | if (userOptional.isEmpty()) {
29 | throw new RequestException(HttpStatus.NOT_FOUND, "P-404", "Bad Credentials.!");
30 | }
31 | User user = userOptional.get();
32 | List roles = roleRepository.findAllByUser(user.getId());
33 | user.setRoles(roles);
34 | return new MyUserPrincipal(userOptional.get());
35 | }
36 |
37 | public MyUserPrincipal loadUserByUsername(String username, String password) {
38 | Optional userOptional = userRepository.findByUsername(username);
39 | //user was found, now we need compare password
40 | if (userOptional.isEmpty()) {
41 | throw new RequestException(HttpStatus.UNAUTHORIZED, "P-401", "Bad Credentials.!");
42 | }
43 | BCryptPasswordEncoder bc = new BCryptPasswordEncoder();
44 | boolean passChecker = bc.matches(password, userOptional.get().getPassword());
45 | if (!passChecker) {
46 | throw new RequestException(HttpStatus.UNAUTHORIZED, "P-401", "Bad Credentials.!");
47 | }
48 | User user = userOptional.get();
49 | List roles = roleRepository.findAllByUser(user.getId());
50 | user.setRoles(roles);
51 | return new MyUserPrincipal(userOptional.get());
52 | }
53 | }
54 |
--------------------------------------------------------------------------------
/src/main/java/com/template/auth/services/UserService.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.services;
2 |
3 | import com.template.auth.exceptions.RequestException;
4 | import com.template.auth.model.Group;
5 | import com.template.auth.model.User;
6 | import com.template.auth.repository.GroupRepository;
7 | import com.template.auth.repository.UserRepository;
8 | import org.springframework.http.HttpStatus;
9 | import org.springframework.stereotype.Service;
10 |
11 | import java.util.List;
12 | import java.util.Optional;
13 | import java.util.stream.Collectors;
14 |
15 | @Service
16 | public class UserService {
17 | private final UserRepository userRepository;
18 | private final GroupRepository groupRepository;
19 | public UserService(UserRepository userRepository, GroupRepository groupRepository) {
20 | this.userRepository = userRepository;
21 | this.groupRepository = groupRepository;
22 | }
23 | public Optional findByUsername(String username){
24 | return userRepository.findByUsername(username);
25 | }
26 | public User save(User user){
27 | Optional prevUser = userRepository.findByUsername(user.getUsername());
28 | if (prevUser.isPresent()){
29 | throw new RequestException(HttpStatus.CONFLICT,"P-409","User already exits");
30 | }
31 | User newUser = new User();
32 | newUser.setName(user.getName());
33 | newUser.setEmail(user.getEmail());
34 | newUser.setPassword(user.getPassword());
35 | newUser.setUsername(user.getUsername());
36 | newUser.setGroups(user.getGroups()
37 | .stream()
38 | .map(group -> {
39 | Group ggroup = group;
40 | if (group.getId() > 0){
41 | ggroup = groupRepository.findById(ggroup.getId()).get();
42 | }
43 | ggroup.addUser(newUser);
44 | return ggroup;
45 |
46 | }).collect(Collectors.toSet()));
47 | return userRepository.save(newUser);
48 | }
49 |
50 | public List findAll() {
51 | return userRepository.findAll();
52 | }
53 | }
54 |
--------------------------------------------------------------------------------
/src/main/resources/application.properties:
--------------------------------------------------------------------------------
1 | spring.datasource.url=jdbc:postgresql://localhost:5432/authdb
2 | spring.datasource.username=authuser
3 | spring.datasource.password=password
4 | server.port=8080
5 | spring.jpa.database-platform=org.hibernate.dialect.PostgreSQLDialect
6 | spring.jpa.hibernate.use-new-id-generator-mappings=false
7 | spring.jpa.show-sql=true
8 | spring.jpa.generate-ddl=true
--------------------------------------------------------------------------------
/src/test/java/com/template/auth/AuthApplicationTests.java:
--------------------------------------------------------------------------------
1 | package com.template.auth;
2 |
3 | import org.junit.jupiter.api.Test;
4 | import org.springframework.boot.test.context.SpringBootTest;
5 |
6 | @SpringBootTest
7 | class AuthApplicationTests {
8 |
9 | @Test
10 | void contextLoads() {
11 | }
12 |
13 | }
14 |
--------------------------------------------------------------------------------
/src/test/java/com/template/auth/controllers/AuthControllerTest.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.controllers;
2 |
3 | import com.template.auth.dto.LoginRequest;
4 | import com.template.auth.dto.TokenResponse;
5 | import com.template.auth.exceptions.RequestException;
6 | import com.template.auth.security.JwtUtils;
7 | import com.template.auth.services.UserDetailService;
8 | import org.checkerframework.checker.units.qual.A;
9 | import org.junit.jupiter.api.BeforeEach;
10 | import org.junit.jupiter.api.Test;
11 | import org.mockito.Mockito;
12 | import org.springframework.beans.factory.annotation.Autowired;
13 | import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
14 | import org.springframework.boot.test.context.SpringBootTest;
15 | import org.springframework.boot.test.mock.mockito.MockBean;
16 | import org.springframework.http.HttpStatus;
17 | import org.springframework.http.ResponseEntity;
18 | import org.springframework.security.authentication.AuthenticationManager;
19 | import org.springframework.security.core.GrantedAuthority;
20 | import org.springframework.security.core.userdetails.UserDetails;
21 | import org.springframework.test.web.servlet.MockMvc;
22 |
23 | import java.util.Collection;
24 | import java.util.Objects;
25 |
26 | import static org.junit.jupiter.api.Assertions.*;
27 |
28 | @SpringBootTest
29 | class AuthControllerTest {
30 |
31 | @Autowired
32 | private UserDetailService userDetailService;
33 | @Autowired
34 | JwtUtils jwtUtils;
35 |
36 | @Autowired
37 | AuthController authController = new AuthController(jwtUtils,userDetailService);
38 |
39 | @Test
40 | void authenticate() {
41 | ResponseEntity response = authController.authenticate(LoginRequest.builder().username("fernandorod").password("12345678").build());
42 | assertNotNull(response);
43 | assertEquals(200,response.getStatusCode().value());
44 |
45 | }
46 |
47 | }
--------------------------------------------------------------------------------
/src/test/java/com/template/auth/security/JwtUtilsTest.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.security;
2 |
3 | import com.template.auth.dto.LoginRequest;
4 | import com.template.auth.model.MyUserPrincipal;
5 | import com.template.auth.model.User;
6 | import com.template.auth.services.UserDetailService;
7 | import org.junit.jupiter.api.Test;
8 | import org.springframework.beans.factory.annotation.Autowired;
9 | import org.springframework.boot.test.context.SpringBootTest;
10 | import org.springframework.security.core.userdetails.UserDetails;
11 |
12 | import java.lang.reflect.InvocationTargetException;
13 | import java.lang.reflect.Method;
14 | import java.util.HashMap;
15 | import java.util.Map;
16 |
17 | import static org.junit.jupiter.api.Assertions.*;
18 | @SpringBootTest
19 | class JwtUtilsTest {
20 |
21 | @Autowired
22 | JwtUtils jwtUtils = new JwtUtils();
23 | @Autowired
24 | UserDetailService userDetailService;
25 |
26 | @Test
27 | void generateToken() {
28 | Map claims = new HashMap<>();
29 | final MyUserPrincipal userDetails = userDetailService.loadUserByUsername("fernandorod", "12345678");
30 | assertNotNull(userDetails);
31 | String token = jwtUtils.createToken(claims,userDetails);
32 | assertNotNull(token);
33 | }
34 |
35 |
36 | }
--------------------------------------------------------------------------------
/src/test/java/com/template/auth/services/UserServiceTest.java:
--------------------------------------------------------------------------------
1 | package com.template.auth.services;
2 |
3 | import com.template.auth.model.User;
4 | import com.template.auth.repository.UserRepository;
5 | import org.assertj.core.api.Assert;
6 | import org.junit.jupiter.api.Test;
7 | import org.springframework.beans.factory.annotation.Autowired;
8 | import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
9 |
10 | import static org.junit.jupiter.api.Assertions.*;
11 |
12 | @DataJpaTest
13 | class UserServiceTest {
14 | // @Autowired
15 | // UserRepository userRepository;
16 |
17 | @Test
18 | void findByUsername() {
19 | // User user = userRepository.findByUsername("igmerdz@gmail.com").get();
20 | // assertEquals("igmerdz@gmail.com",user.getEmail());
21 | }
22 |
23 | @Test
24 | void save() {
25 | }
26 | }
--------------------------------------------------------------------------------