09-spring-boot-security.html 77KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="UTF-8">
  5. <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <meta name="generator" content="Asciidoctor 1.5.5">
  8. <title>Spring Boot Security</title>
  9. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
  10. <style>
  11. /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
  12. /* Remove comment around @import statement below when using as a custom stylesheet */
  13. /*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
  14. article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
  15. audio,canvas,video{display:inline-block}
  16. audio:not([controls]){display:none;height:0}
  17. [hidden],template{display:none}
  18. script{display:none!important}
  19. html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
  20. a{background:transparent}
  21. a:focus{outline:thin dotted}
  22. a:active,a:hover{outline:0}
  23. h1{font-size:2em;margin:.67em 0}
  24. abbr[title]{border-bottom:1px dotted}
  25. b,strong{font-weight:bold}
  26. dfn{font-style:italic}
  27. hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
  28. mark{background:#ff0;color:#000}
  29. code,kbd,pre,samp{font-family:monospace;font-size:1em}
  30. pre{white-space:pre-wrap}
  31. q{quotes:"\201C" "\201D" "\2018" "\2019"}
  32. small{font-size:80%}
  33. sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
  34. sup{top:-.5em}
  35. sub{bottom:-.25em}
  36. img{border:0}
  37. svg:not(:root){overflow:hidden}
  38. figure{margin:0}
  39. fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
  40. legend{border:0;padding:0}
  41. button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
  42. button,input{line-height:normal}
  43. button,select{text-transform:none}
  44. button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
  45. button[disabled],html input[disabled]{cursor:default}
  46. input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
  47. input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}
  48. input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}
  49. button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
  50. textarea{overflow:auto;vertical-align:top}
  51. table{border-collapse:collapse;border-spacing:0}
  52. *,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
  53. html,body{font-size:100%}
  54. body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
  55. a:hover{cursor:pointer}
  56. img,object,embed{max-width:100%;height:auto}
  57. object,embed{height:100%}
  58. img{-ms-interpolation-mode:bicubic}
  59. .left{float:left!important}
  60. .right{float:right!important}
  61. .text-left{text-align:left!important}
  62. .text-right{text-align:right!important}
  63. .text-center{text-align:center!important}
  64. .text-justify{text-align:justify!important}
  65. .hide{display:none}
  66. img,object,svg{display:inline-block;vertical-align:middle}
  67. textarea{height:auto;min-height:50px}
  68. select{width:100%}
  69. .center{margin-left:auto;margin-right:auto}
  70. .spread{width:100%}
  71. p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6}
  72. .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
  73. div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
  74. a{color:#2156a5;text-decoration:underline;line-height:inherit}
  75. a:hover,a:focus{color:#1d4b8f}
  76. a img{border:none}
  77. p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
  78. p aside{font-size:.875em;line-height:1.35;font-style:italic}
  79. h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
  80. h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
  81. h1{font-size:2.125em}
  82. h2{font-size:1.6875em}
  83. h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
  84. h4,h5{font-size:1.125em}
  85. h6{font-size:1em}
  86. hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
  87. em,i{font-style:italic;line-height:inherit}
  88. strong,b{font-weight:bold;line-height:inherit}
  89. small{font-size:60%;line-height:inherit}
  90. code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
  91. ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
  92. ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em}
  93. ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
  94. ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
  95. ul.square{list-style-type:square}
  96. ul.circle{list-style-type:circle}
  97. ul.disc{list-style-type:disc}
  98. ul.no-bullet{list-style:none}
  99. ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
  100. dl dt{margin-bottom:.3125em;font-weight:bold}
  101. dl dd{margin-bottom:1.25em}
  102. abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
  103. abbr{text-transform:none}
  104. blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
  105. blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
  106. blockquote cite:before{content:"\2014 \0020"}
  107. blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
  108. blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
  109. @media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
  110. h1{font-size:2.75em}
  111. h2{font-size:2.3125em}
  112. h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
  113. h4{font-size:1.4375em}}
  114. table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
  115. table thead,table tfoot{background:#f7f8f7;font-weight:bold}
  116. table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
  117. table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
  118. table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
  119. table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
  120. h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
  121. h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
  122. .clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table}
  123. .clearfix:after,.float-group:after{clear:both}
  124. *:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
  125. *:not(pre)>code.nobreak{word-wrap:normal}
  126. *:not(pre)>code.nowrap{white-space:nowrap}
  127. pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
  128. em em{font-style:normal}
  129. strong strong{font-weight:400}
  130. .keyseq{color:rgba(51,51,51,.8)}
  131. kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
  132. .keyseq kbd:first-child{margin-left:0}
  133. .keyseq kbd:last-child{margin-right:0}
  134. .menuseq,.menu{color:rgba(0,0,0,.8)}
  135. b.button:before,b.button:after{position:relative;top:-1px;font-weight:400}
  136. b.button:before{content:"[";padding:0 3px 0 2px}
  137. b.button:after{content:"]";padding:0 2px 0 3px}
  138. p a>code:hover{color:rgba(0,0,0,.9)}
  139. #header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
  140. #header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table}
  141. #header:after,#content:after,#footnotes:after,#footer:after{clear:both}
  142. #content{margin-top:1.25em}
  143. #content:before{content:none}
  144. #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
  145. #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
  146. #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
  147. #header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
  148. #header .details span:first-child{margin-left:-.125em}
  149. #header .details span.email a{color:rgba(0,0,0,.85)}
  150. #header .details br{display:none}
  151. #header .details br+span:before{content:"\00a0\2013\00a0"}
  152. #header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
  153. #header .details br+span#revremark:before{content:"\00a0|\00a0"}
  154. #header #revnumber{text-transform:capitalize}
  155. #header #revnumber:after{content:"\00a0"}
  156. #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
  157. #toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
  158. #toc>ul{margin-left:.125em}
  159. #toc ul.sectlevel0>li>a{font-style:italic}
  160. #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
  161. #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
  162. #toc li{line-height:1.3334;margin-top:.3334em}
  163. #toc a{text-decoration:none}
  164. #toc a:active{text-decoration:underline}
  165. #toctitle{color:#7a2518;font-size:1.2em}
  166. @media only screen and (min-width:768px){#toctitle{font-size:1.375em}
  167. body.toc2{padding-left:15em;padding-right:0}
  168. #toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
  169. #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
  170. #toc.toc2>ul{font-size:.9em;margin-bottom:0}
  171. #toc.toc2 ul ul{margin-left:0;padding-left:1em}
  172. #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
  173. body.toc2.toc-right{padding-left:0;padding-right:15em}
  174. body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}
  175. @media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
  176. #toc.toc2{width:20em}
  177. #toc.toc2 #toctitle{font-size:1.375em}
  178. #toc.toc2>ul{font-size:.95em}
  179. #toc.toc2 ul ul{padding-left:1.25em}
  180. body.toc2.toc-right{padding-left:0;padding-right:20em}}
  181. #content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
  182. #content #toc>:first-child{margin-top:0}
  183. #content #toc>:last-child{margin-bottom:0}
  184. #footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
  185. #footer-text{color:rgba(255,255,255,.8);line-height:1.44}
  186. .sect1{padding-bottom:.625em}
  187. @media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}
  188. .sect1+.sect1{border-top:1px solid #efefed}
  189. #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
  190. #content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
  191. #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
  192. #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
  193. #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
  194. .audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
  195. .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
  196. table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0}
  197. .paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)}
  198. table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit}
  199. .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
  200. .admonitionblock>table td.icon{text-align:center;width:80px}
  201. .admonitionblock>table td.icon img{max-width:none}
  202. .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
  203. .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
  204. .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
  205. .exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
  206. .exampleblock>.content>:first-child{margin-top:0}
  207. .exampleblock>.content>:last-child{margin-bottom:0}
  208. .sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
  209. .sidebarblock>:first-child{margin-top:0}
  210. .sidebarblock>:last-child{margin-bottom:0}
  211. .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
  212. .exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
  213. .literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
  214. .sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}
  215. .literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em}
  216. .literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
  217. @media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
  218. @media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
  219. .literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
  220. .listingblock pre.highlightjs{padding:0}
  221. .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
  222. .listingblock pre.prettyprint{border-width:0}
  223. .listingblock>.content{position:relative}
  224. .listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}
  225. .listingblock:hover code[data-lang]:before{display:block}
  226. .listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999}
  227. .listingblock.terminal pre .command:not([data-prompt]):before{content:"$"}
  228. table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
  229. table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
  230. table.pyhltable td.code{padding-left:.75em;padding-right:0}
  231. pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
  232. pre.pygments .lineno{display:inline-block;margin-right:.25em}
  233. table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
  234. .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
  235. .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
  236. .quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
  237. .quoteblock blockquote{margin:0;padding:0;border:0}
  238. .quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
  239. .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
  240. .quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
  241. .quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
  242. .quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
  243. .quoteblock .quoteblock blockquote:before{display:none}
  244. .verseblock{margin:0 1em 1.25em 1em}
  245. .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
  246. .verseblock pre strong{font-weight:400}
  247. .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
  248. .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
  249. .quoteblock .attribution br,.verseblock .attribution br{display:none}
  250. .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
  251. .quoteblock.abstract{margin:0 0 1.25em 0;display:block}
  252. .quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0}
  253. .quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none}
  254. table.tableblock{max-width:100%;border-collapse:separate}
  255. table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0}
  256. table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
  257. table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0}
  258. table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0}
  259. table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0}
  260. table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0}
  261. table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0}
  262. table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0}
  263. table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0}
  264. table.frame-all{border-width:1px}
  265. table.frame-sides{border-width:0 1px}
  266. table.frame-topbot{border-width:1px 0}
  267. th.halign-left,td.halign-left{text-align:left}
  268. th.halign-right,td.halign-right{text-align:right}
  269. th.halign-center,td.halign-center{text-align:center}
  270. th.valign-top,td.valign-top{vertical-align:top}
  271. th.valign-bottom,td.valign-bottom{vertical-align:bottom}
  272. th.valign-middle,td.valign-middle{vertical-align:middle}
  273. table thead th,table tfoot th{font-weight:bold}
  274. tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
  275. tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
  276. p.tableblock>code:only-child{background:none;padding:0}
  277. p.tableblock{font-size:1em}
  278. td>div.verse{white-space:pre}
  279. ol{margin-left:1.75em}
  280. ul li ol{margin-left:1.5em}
  281. dl dd{margin-left:1.125em}
  282. dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
  283. ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
  284. ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none}
  285. ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em}
  286. ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1em;font-size:.85em}
  287. ul.checklist li>p:first-child>input[type="checkbox"]:first-child{width:1em;position:relative;top:1px}
  288. ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden}
  289. ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block}
  290. ul.inline>li>*{display:block}
  291. .unstyled dl dt{font-weight:400;font-style:normal}
  292. ol.arabic{list-style-type:decimal}
  293. ol.decimal{list-style-type:decimal-leading-zero}
  294. ol.loweralpha{list-style-type:lower-alpha}
  295. ol.upperalpha{list-style-type:upper-alpha}
  296. ol.lowerroman{list-style-type:lower-roman}
  297. ol.upperroman{list-style-type:upper-roman}
  298. ol.lowergreek{list-style-type:lower-greek}
  299. .hdlist>table,.colist>table{border:0;background:none}
  300. .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
  301. td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
  302. td.hdlist1{font-weight:bold;padding-bottom:1.25em}
  303. .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
  304. .colist>table tr>td:first-of-type{padding:0 .75em;line-height:1}
  305. .colist>table tr>td:last-of-type{padding:.25em 0}
  306. .thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
  307. .imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
  308. .imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
  309. .imageblock>.title{margin-bottom:0}
  310. .imageblock.thumb,.imageblock.th{border-width:6px}
  311. .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
  312. .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
  313. .image.left{margin-right:.625em}
  314. .image.right{margin-left:.625em}
  315. a.image{text-decoration:none;display:inline-block}
  316. a.image object{pointer-events:none}
  317. sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
  318. sup.footnote a,sup.footnoteref a{text-decoration:none}
  319. sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
  320. #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
  321. #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0}
  322. #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;text-indent:-1.05em;margin-bottom:.2em}
  323. #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none}
  324. #footnotes .footnote:last-of-type{margin-bottom:0}
  325. #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
  326. .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
  327. .gist .file-data>table td.line-data{width:99%}
  328. div.unbreakable{page-break-inside:avoid}
  329. .big{font-size:larger}
  330. .small{font-size:smaller}
  331. .underline{text-decoration:underline}
  332. .overline{text-decoration:overline}
  333. .line-through{text-decoration:line-through}
  334. .aqua{color:#00bfbf}
  335. .aqua-background{background-color:#00fafa}
  336. .black{color:#000}
  337. .black-background{background-color:#000}
  338. .blue{color:#0000bf}
  339. .blue-background{background-color:#0000fa}
  340. .fuchsia{color:#bf00bf}
  341. .fuchsia-background{background-color:#fa00fa}
  342. .gray{color:#606060}
  343. .gray-background{background-color:#7d7d7d}
  344. .green{color:#006000}
  345. .green-background{background-color:#007d00}
  346. .lime{color:#00bf00}
  347. .lime-background{background-color:#00fa00}
  348. .maroon{color:#600000}
  349. .maroon-background{background-color:#7d0000}
  350. .navy{color:#000060}
  351. .navy-background{background-color:#00007d}
  352. .olive{color:#606000}
  353. .olive-background{background-color:#7d7d00}
  354. .purple{color:#600060}
  355. .purple-background{background-color:#7d007d}
  356. .red{color:#bf0000}
  357. .red-background{background-color:#fa0000}
  358. .silver{color:#909090}
  359. .silver-background{background-color:#bcbcbc}
  360. .teal{color:#006060}
  361. .teal-background{background-color:#007d7d}
  362. .white{color:#bfbfbf}
  363. .white-background{background-color:#fafafa}
  364. .yellow{color:#bfbf00}
  365. .yellow-background{background-color:#fafa00}
  366. span.icon>.fa{cursor:default}
  367. .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
  368. .admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c}
  369. .admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
  370. .admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900}
  371. .admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400}
  372. .admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000}
  373. .conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
  374. .conum[data-value] *{color:#fff!important}
  375. .conum[data-value]+b{display:none}
  376. .conum[data-value]:after{content:attr(data-value)}
  377. pre .conum[data-value]{position:relative;top:-.125em}
  378. b.conum *{color:inherit!important}
  379. .conum:not([data-value]):empty{display:none}
  380. dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
  381. h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
  382. p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
  383. p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
  384. p{margin-bottom:1.25rem}
  385. .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
  386. .exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
  387. .print-only{display:none!important}
  388. @media print{@page{margin:1.25cm .75cm}
  389. *{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
  390. a{color:inherit!important;text-decoration:underline!important}
  391. a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
  392. a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
  393. abbr[title]:after{content:" (" attr(title) ")"}
  394. pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
  395. thead{display:table-header-group}
  396. svg{max-width:100%}
  397. p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
  398. h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
  399. #toc,.sidebarblock,.exampleblock>.content{background:none!important}
  400. #toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
  401. .sect1{padding-bottom:0!important}
  402. .sect1+.sect1{border:0!important}
  403. #header>h1:first-child{margin-top:1.25rem}
  404. body.book #header{text-align:center}
  405. body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0}
  406. body.book #header .details{border:0!important;display:block;padding:0!important}
  407. body.book #header .details span:first-child{margin-left:0!important}
  408. body.book #header .details br{display:block}
  409. body.book #header .details br+span:before{content:none!important}
  410. body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
  411. body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
  412. .listingblock code[data-lang]:before{display:block}
  413. #footer{background:none!important;padding:0 .9375em}
  414. #footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em}
  415. .hide-on-print{display:none!important}
  416. .print-only{display:block!important}
  417. .hide-for-print{display:none!important}
  418. .show-for-print{display:inherit!important}}
  419. </style>
  420. <style>
  421. /* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */
  422. /*pre.CodeRay {background-color:#f7f7f8;}*/
  423. .CodeRay .line-numbers{border-right:1px solid #d8d8d8;padding:0 0.5em 0 .25em}
  424. .CodeRay span.line-numbers{display:inline-block;margin-right:.5em;color:rgba(0,0,0,.3)}
  425. .CodeRay .line-numbers strong{color:rgba(0,0,0,.4)}
  426. table.CodeRay{border-collapse:separate;border-spacing:0;margin-bottom:0;border:0;background:none}
  427. table.CodeRay td{vertical-align: top;line-height:1.45}
  428. table.CodeRay td.line-numbers{text-align:right}
  429. table.CodeRay td.line-numbers>pre{padding:0;color:rgba(0,0,0,.3)}
  430. table.CodeRay td.code{padding:0 0 0 .5em}
  431. table.CodeRay td.code>pre{padding:0}
  432. .CodeRay .debug{color:#fff !important;background:#000080 !important}
  433. .CodeRay .annotation{color:#007}
  434. .CodeRay .attribute-name{color:#000080}
  435. .CodeRay .attribute-value{color:#700}
  436. .CodeRay .binary{color:#509}
  437. .CodeRay .comment{color:#998;font-style:italic}
  438. .CodeRay .char{color:#04d}
  439. .CodeRay .char .content{color:#04d}
  440. .CodeRay .char .delimiter{color:#039}
  441. .CodeRay .class{color:#458;font-weight:bold}
  442. .CodeRay .complex{color:#a08}
  443. .CodeRay .constant,.CodeRay .predefined-constant{color:#008080}
  444. .CodeRay .color{color:#099}
  445. .CodeRay .class-variable{color:#369}
  446. .CodeRay .decorator{color:#b0b}
  447. .CodeRay .definition{color:#099}
  448. .CodeRay .delimiter{color:#000}
  449. .CodeRay .doc{color:#970}
  450. .CodeRay .doctype{color:#34b}
  451. .CodeRay .doc-string{color:#d42}
  452. .CodeRay .escape{color:#666}
  453. .CodeRay .entity{color:#800}
  454. .CodeRay .error{color:#808}
  455. .CodeRay .exception{color:inherit}
  456. .CodeRay .filename{color:#099}
  457. .CodeRay .function{color:#900;font-weight:bold}
  458. .CodeRay .global-variable{color:#008080}
  459. .CodeRay .hex{color:#058}
  460. .CodeRay .integer,.CodeRay .float{color:#099}
  461. .CodeRay .include{color:#555}
  462. .CodeRay .inline{color:#000}
  463. .CodeRay .inline .inline{background:#ccc}
  464. .CodeRay .inline .inline .inline{background:#bbb}
  465. .CodeRay .inline .inline-delimiter{color:#d14}
  466. .CodeRay .inline-delimiter{color:#d14}
  467. .CodeRay .important{color:#555;font-weight:bold}
  468. .CodeRay .interpreted{color:#b2b}
  469. .CodeRay .instance-variable{color:#008080}
  470. .CodeRay .label{color:#970}
  471. .CodeRay .local-variable{color:#963}
  472. .CodeRay .octal{color:#40e}
  473. .CodeRay .predefined{color:#369}
  474. .CodeRay .preprocessor{color:#579}
  475. .CodeRay .pseudo-class{color:#555}
  476. .CodeRay .directive{font-weight:bold}
  477. .CodeRay .type{font-weight:bold}
  478. .CodeRay .predefined-type{color:inherit}
  479. .CodeRay .reserved,.CodeRay .keyword {color:#000;font-weight:bold}
  480. .CodeRay .key{color:#808}
  481. .CodeRay .key .delimiter{color:#606}
  482. .CodeRay .key .char{color:#80f}
  483. .CodeRay .value{color:#088}
  484. .CodeRay .regexp .delimiter{color:#808}
  485. .CodeRay .regexp .content{color:#808}
  486. .CodeRay .regexp .modifier{color:#808}
  487. .CodeRay .regexp .char{color:#d14}
  488. .CodeRay .regexp .function{color:#404;font-weight:bold}
  489. .CodeRay .string{color:#d20}
  490. .CodeRay .string .string .string{background:#ffd0d0}
  491. .CodeRay .string .content{color:#d14}
  492. .CodeRay .string .char{color:#d14}
  493. .CodeRay .string .delimiter{color:#d14}
  494. .CodeRay .shell{color:#d14}
  495. .CodeRay .shell .delimiter{color:#d14}
  496. .CodeRay .symbol{color:#990073}
  497. .CodeRay .symbol .content{color:#a60}
  498. .CodeRay .symbol .delimiter{color:#630}
  499. .CodeRay .tag{color:#008080}
  500. .CodeRay .tag-special{color:#d70}
  501. .CodeRay .variable{color:#036}
  502. .CodeRay .insert{background:#afa}
  503. .CodeRay .delete{background:#faa}
  504. .CodeRay .change{color:#aaf;background:#007}
  505. .CodeRay .head{color:#f8f;background:#505}
  506. .CodeRay .insert .insert{color:#080}
  507. .CodeRay .delete .delete{color:#800}
  508. .CodeRay .change .change{color:#66f}
  509. .CodeRay .head .head{color:#f4f}
  510. </style>
  511. <link rel="stylesheet"
  512. href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"
  513. integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u"
  514. crossorigin="anonymous">
  515. <link rel="stylesheet"
  516. href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap-theme.min.css"
  517. integrity="sha384-rHyoN1iRsVXV4nD0JutlnGaslCJuC7uwjduW9SVrLvRYooPp2bWYgmgJQIXwl/Sp"
  518. crossorigin="anonymous">
  519. <style>
  520. .c2cb{
  521. position: absolute; left: 0; top: 0;
  522. cursor: pointer
  523. }
  524. .c2cb:focus {
  525. outline: none;
  526. }
  527. body {
  528. font-size: 18px;
  529. }
  530. p {
  531. font-size: 18px;
  532. }
  533. td.content {
  534. font-size:2.0625rem;
  535. }
  536. div.title {
  537. font-size:2.0625rem;
  538. }
  539. </style>
  540. <script src="js/jquery-3.2.1.min.js"></script>
  541. <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js"></script>
  542. <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>
  543. <script>
  544. $(function() {
  545. var button = $("<div style='padding: 10px;'><button data-toggle='tooltip' placement='right' data-trigger='click' title='Copied!' class='c2cb glyphicon glyphicon-copy'></button></div>");
  546. $(".listingblock > .content pre").prepend(button);
  547. $('[data-toggle="tooltip"]').tooltip();
  548. $('[data-toggle="tooltip"]').mouseout(function() {
  549. $(this).tooltip('hide');
  550. $(this).trigger('blur');
  551. });
  552. var clipboard = new Clipboard('.c2cb', {
  553. target: function(c2cb) {
  554. return $(c2cb).parent().siblings("code")[0];
  555. }
  556. });
  557. clipboard.on('success', function(e) {
  558. e.clearSelection();
  559. });
  560. });
  561. </script>
  562. </head>
  563. <body class="article toc2 toc-left">
  564. <div id="header">
  565. <h1><a id="spring-boot-security"></a>Spring Boot Security</h1>
  566. <div id="toc" class="toc2">
  567. <div id="toctitle">Labs</div>
  568. <ul class="sectlevel1">
  569. <li><a href="#_directory_web_security_app">Directory Web Security App</a></li>
  570. <li><a href="#_code_snippet_manager_security">Code Snippet Manager Security</a>
  571. <ul class="sectlevel2">
  572. <li><a href="#_challenges">Challenges</a></li>
  573. </ul>
  574. </li>
  575. <li><a href="#_homework">HOMEWORK</a></li>
  576. </ul>
  577. </div>
  578. </div>
  579. <div id="content">
  580. <div id="preamble">
  581. <div class="sectionbody">
  582. <div class="paragraph">
  583. <p>Get familiar with <strong>Spring Security</strong> and the <strong>Spring Boot Security</strong> features.</p>
  584. </div>
  585. <div class="paragraph">
  586. <p><strong>Time:</strong> 35 minutes.</p>
  587. </div>
  588. <!-- toc disabled -->
  589. </div>
  590. </div>
  591. <div class="sect1">
  592. <h2 id="_directory_web_security_app">Directory Web Security App</h2>
  593. <div class="sectionbody">
  594. <div class="paragraph">
  595. <p>Remember this lab? Where we have a persons directory? We are going to re-take part of the code and make this project more secure.
  596. You saw in the demo how easy is to set up the security using the JDBC but it was using a pre-configured schema (<strong>users</strong> and <strong>authorities</strong>).
  597. In this lab we will use our own schema (our own data) so you see how easy is to implement <strong>spring-security</strong> in a web project.</p>
  598. </div>
  599. <div class="olist arabic">
  600. <ol class="arabic">
  601. <li>
  602. <p>Open a browser and hit the url: <a href="http://start.spring.io" class="bare" target="_blank">http://start.spring.io</a></p>
  603. </li>
  604. <li>
  605. <p>Click the <strong><em>Switch to the full version</em></strong> link.</p>
  606. </li>
  607. <li>
  608. <p>Fill out the Directory Web App Project metadata with (See Figure 1.0):</p>
  609. <table class="tableblock frame-all grid-all spread">
  610. <caption class="title">Table 1. Directory Web Security App - metadata</caption>
  611. <colgroup>
  612. <col style="width: 16.6666%;">
  613. <col style="width: 83.3334%;">
  614. </colgroup>
  615. <thead>
  616. <tr>
  617. <th class="tableblock halign-left valign-top">Property</th>
  618. <th class="tableblock halign-left valign-top">Value</th>
  619. </tr>
  620. </thead>
  621. <tbody>
  622. <tr>
  623. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Group</strong>:</p></td>
  624. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>io.pivotal.workshop</em></p></td>
  625. </tr>
  626. <tr>
  627. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Artifact</strong>:</p></td>
  628. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>directory-web-security</em></p></td>
  629. </tr>
  630. <tr>
  631. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Name</strong>:</p></td>
  632. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>directory-web-security</em></p></td>
  633. </tr>
  634. <tr>
  635. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Package Name</strong>:</p></td>
  636. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>io.pivotal.workshop.directory</em></p></td>
  637. </tr>
  638. <tr>
  639. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Dependencies</strong>:</p></td>
  640. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>Web</em>, <em>DevTools</em>, <em>H2</em>, <em>MySQL</em>, <em>Security</em>, <em>JPA</em>, <em>Rest Repositories</em>, <em>Actuator</em>, <em>HATEOAS</em>, <em>Groovy Templates</em></p></td>
  641. </tr>
  642. <tr>
  643. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Spring Boot</strong>:</p></td>
  644. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>2.0.0.M7</em></p></td>
  645. </tr>
  646. </tbody>
  647. </table>
  648. <div class="paragraph">
  649. <div class="title">Figure 1.0: Spring Initializr - <a href="http://start.spring.io" class="bare" target="_blank">http://start.spring.io</a></div>
  650. <p><span class="image"><img src="images/09-spring-boot-security-01.png" alt="SpringInitializr" title="Spring Initializr"></span></p>
  651. </div>
  652. <div class="admonitionblock tip">
  653. <table>
  654. <tr>
  655. <td class="icon">
  656. <div class="title">Tip</div>
  657. </td>
  658. <td class="content">
  659. You can choose either <strong>Maven</strong> or <strong>Gradle</strong> project types.
  660. </td>
  661. </tr>
  662. </table>
  663. </div>
  664. </li>
  665. <li>
  666. <p>Type <strong>Web</strong>, <strong>DevTools</strong>, <strong>H2</strong>, <strong>MySQL</strong>, <strong>Security</strong>, <strong>JPA</strong>, <strong>Rest Repositories</strong>, <strong>Actuator</strong>, <strong>HATEOAS</strong> and <strong>Groovy Templates</strong> in the <strong><em>Dependencies</em></strong> field and press Enter.</p>
  667. </li>
  668. <li>
  669. <p>Click the <strong><em>Generate Project</em></strong> button.</p>
  670. </li>
  671. <li>
  672. <p>Unzip the file in any directory you want.</p>
  673. </li>
  674. <li>
  675. <p>Import your project in any IDE you want.</p>
  676. </li>
  677. <li>
  678. <p>You can copy the code from the first labs (<strong>Spring Boot Overview</strong>).</p>
  679. </li>
  680. <li>
  681. <p>Because we are using <strong>JPA</strong> and <strong>Rest Repositories</strong> dependencies, lets convert the <strong>Person</strong> as entity. Create/Modify the <strong>Person</strong> class:</p>
  682. <div class="listingblock">
  683. <div class="title">io.pivotal.workshop.directory.domain.Person.java</div>
  684. <div class="content">
  685. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.domain</span>;
  686. <span class="keyword">import</span> <span class="include">java.text.ParseException</span>;
  687. <span class="keyword">import</span> <span class="include">java.text.SimpleDateFormat</span>;
  688. <span class="keyword">import</span> <span class="include">java.util.Date</span>;
  689. <span class="keyword">import</span> <span class="include">javax.persistence.Column</span>;
  690. <span class="keyword">import</span> <span class="include">javax.persistence.Entity</span>;
  691. <span class="keyword">import</span> <span class="include">javax.persistence.GeneratedValue</span>;
  692. <span class="keyword">import</span> <span class="include">javax.persistence.Id</span>;
  693. <span class="keyword">import</span> <span class="include">javax.persistence.PrePersist</span>;
  694. <span class="keyword">import</span> <span class="include">javax.persistence.PreUpdate</span>;
  695. <span class="keyword">import</span> <span class="include">javax.persistence.Transient</span>;
  696. <span class="keyword">import</span> <span class="include">org.hibernate.annotations.GenericGenerator</span>;
  697. <span class="annotation">@Entity</span>
  698. <span class="directive">public</span> <span class="type">class</span> <span class="class">Person</span> {
  699. <span class="annotation">@Transient</span>
  700. <span class="directive">private</span> <span class="predefined-type">SimpleDateFormat</span> date = <span class="keyword">new</span> <span class="predefined-type">SimpleDateFormat</span>(<span class="string"><span class="delimiter">&quot;</span><span class="content">yyyy-MM-dd</span><span class="delimiter">&quot;</span></span>);
  701. <span class="annotation">@Id</span>
  702. <span class="annotation">@GeneratedValue</span>(generator = <span class="string"><span class="delimiter">&quot;</span><span class="content">system-uuid</span><span class="delimiter">&quot;</span></span>)
  703. <span class="annotation">@GenericGenerator</span>(name = <span class="string"><span class="delimiter">&quot;</span><span class="content">system-uuid</span><span class="delimiter">&quot;</span></span>, strategy = <span class="string"><span class="delimiter">&quot;</span><span class="content">uuid</span><span class="delimiter">&quot;</span></span>)
  704. <span class="directive">private</span> <span class="predefined-type">String</span> id;
  705. <span class="annotation">@Column</span>(unique = <span class="predefined-constant">true</span>)
  706. <span class="directive">private</span> <span class="predefined-type">String</span> email;
  707. <span class="directive">private</span> <span class="predefined-type">String</span> name;
  708. <span class="directive">private</span> <span class="predefined-type">String</span> password;
  709. <span class="directive">private</span> <span class="predefined-type">String</span> role = <span class="string"><span class="delimiter">&quot;</span><span class="content">USER</span><span class="delimiter">&quot;</span></span>;
  710. <span class="directive">private</span> <span class="type">boolean</span> enabled = <span class="predefined-constant">true</span>;
  711. <span class="directive">private</span> <span class="predefined-type">Date</span> birthday;
  712. <span class="annotation">@Column</span>(insertable = <span class="predefined-constant">true</span>, updatable = <span class="predefined-constant">false</span>)
  713. <span class="directive">private</span> <span class="predefined-type">Date</span> created;
  714. <span class="directive">private</span> <span class="predefined-type">Date</span> modified;
  715. <span class="directive">public</span> Person() {
  716. <span class="local-variable">this</span>.created = <span class="keyword">new</span> <span class="predefined-type">Date</span>();
  717. <span class="local-variable">this</span>.modified = <span class="keyword">new</span> <span class="predefined-type">Date</span>();
  718. }
  719. <span class="directive">public</span> Person(<span class="predefined-type">String</span> email, <span class="predefined-type">String</span> name, <span class="predefined-type">String</span> password, <span class="predefined-type">String</span> birthday) {
  720. <span class="local-variable">this</span>();
  721. <span class="local-variable">this</span>.email = email;
  722. <span class="local-variable">this</span>.name = name;
  723. <span class="local-variable">this</span>.password = password;
  724. <span class="keyword">try</span> {
  725. <span class="local-variable">this</span>.birthday = date.parse(birthday);
  726. } <span class="keyword">catch</span> (<span class="exception">ParseException</span> e) {
  727. <span class="local-variable">this</span>.birthday = <span class="predefined-constant">null</span>;
  728. }
  729. }
  730. <span class="directive">public</span> Person(<span class="predefined-type">String</span> email, <span class="predefined-type">String</span> name, <span class="predefined-type">String</span> password, <span class="predefined-type">Date</span> birthday) {
  731. <span class="local-variable">this</span>();
  732. <span class="local-variable">this</span>.email = email;
  733. <span class="local-variable">this</span>.name = name;
  734. <span class="local-variable">this</span>.password = password;
  735. <span class="local-variable">this</span>.birthday = birthday;
  736. }
  737. <span class="directive">public</span> Person(<span class="predefined-type">String</span> email, <span class="predefined-type">String</span> name, <span class="predefined-type">String</span> password, <span class="predefined-type">String</span> birthday, <span class="predefined-type">String</span> role, <span class="type">boolean</span> enabled) {
  738. <span class="local-variable">this</span>(email, name, password, birthday);
  739. <span class="local-variable">this</span>.role = role;
  740. <span class="local-variable">this</span>.enabled = enabled;
  741. }
  742. <span class="directive">public</span> <span class="predefined-type">String</span> getId() {
  743. <span class="keyword">return</span> id;
  744. }
  745. <span class="directive">public</span> <span class="type">void</span> setId(<span class="predefined-type">String</span> id) {
  746. <span class="local-variable">this</span>.id = id;
  747. }
  748. <span class="directive">public</span> <span class="predefined-type">String</span> getEmail() {
  749. <span class="keyword">return</span> email;
  750. }
  751. <span class="directive">public</span> <span class="type">void</span> setEmail(<span class="predefined-type">String</span> email) {
  752. <span class="local-variable">this</span>.email = email;
  753. }
  754. <span class="directive">public</span> <span class="predefined-type">String</span> getName() {
  755. <span class="keyword">return</span> name;
  756. }
  757. <span class="directive">public</span> <span class="type">void</span> setName(<span class="predefined-type">String</span> name) {
  758. <span class="local-variable">this</span>.name = name;
  759. }
  760. <span class="directive">public</span> <span class="predefined-type">String</span> getPassword() {
  761. <span class="keyword">return</span> password;
  762. }
  763. <span class="directive">public</span> <span class="type">void</span> setPassword(<span class="predefined-type">String</span> password) {
  764. <span class="local-variable">this</span>.password = password;
  765. }
  766. <span class="directive">public</span> <span class="predefined-type">Date</span> getBirthday() {
  767. <span class="keyword">return</span> birthday;
  768. }
  769. <span class="directive">public</span> <span class="type">void</span> setBirthday(<span class="predefined-type">Date</span> birthday) {
  770. <span class="local-variable">this</span>.birthday = birthday;
  771. }
  772. <span class="directive">public</span> <span class="predefined-type">Date</span> getCreated() {
  773. <span class="keyword">return</span> created;
  774. }
  775. <span class="directive">public</span> <span class="predefined-type">Date</span> getModified() {
  776. <span class="keyword">return</span> modified;
  777. }
  778. <span class="directive">public</span> <span class="predefined-type">String</span> getRole() {
  779. <span class="keyword">return</span> role;
  780. }
  781. <span class="directive">public</span> <span class="type">void</span> setRole(<span class="predefined-type">String</span> role) {
  782. <span class="local-variable">this</span>.role = role;
  783. }
  784. <span class="directive">public</span> <span class="type">boolean</span> isEnabled() {
  785. <span class="keyword">return</span> enabled;
  786. }
  787. <span class="directive">public</span> <span class="type">void</span> setEnabled(<span class="type">boolean</span> enabled) {
  788. <span class="local-variable">this</span>.enabled = enabled;
  789. }
  790. <span class="annotation">@PrePersist</span>
  791. <span class="type">void</span> onCreate() {
  792. <span class="local-variable">this</span>.created = <span class="keyword">new</span> <span class="predefined-type">Date</span>();
  793. <span class="local-variable">this</span>.modified = <span class="keyword">new</span> <span class="predefined-type">Date</span>();
  794. }
  795. <span class="annotation">@PreUpdate</span>
  796. <span class="type">void</span> onUpdate() {
  797. <span class="local-variable">this</span>.modified = <span class="keyword">new</span> <span class="predefined-type">Date</span>();
  798. }
  799. }</code></pre>
  800. </div>
  801. </div>
  802. <div class="paragraph">
  803. <p>See that we are using the <strong>@Entity</strong> and <strong>@Id</strong> annotations from <strong>JPA</strong>. What is new in this class is the two new fields: <strong>role</strong> and <strong>enabled</strong>, that we are going to use later on.</p>
  804. </div>
  805. </li>
  806. <li>
  807. <p>Next, create/modify the <strong>PersonRepository</strong> class:</p>
  808. <div class="listingblock">
  809. <div class="title">io.pivotal.workshop.directory.repository.PersonRepository.java</div>
  810. <div class="content">
  811. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.repository</span>;
  812. <span class="keyword">import</span> <span class="include">org.springframework.data.repository.CrudRepository</span>;
  813. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.domain.Person</span>;
  814. <span class="keyword">import</span> <span class="include">org.springframework.data.repository.query.Param</span>;
  815. <span class="directive">public</span> <span class="type">interface</span> <span class="class">PersonRepository</span> <span class="directive">extends</span> CrudRepository&lt;Person,<span class="predefined-type">String</span>&gt;{
  816. <span class="directive">public</span> Person findByEmailIgnoreCase(<span class="annotation">@Param</span>(<span class="string"><span class="delimiter">&quot;</span><span class="content">email</span><span class="delimiter">&quot;</span></span>) <span class="predefined-type">String</span> email);
  817. }</code></pre>
  818. </div>
  819. </div>
  820. <div class="paragraph">
  821. <p>This is part of the <strong>spring-data</strong> project, where only by extending from the <strong>CrudRepository&lt;T,ID&gt;</strong> interface we get all the persistence functionality. Also take a look that we are defining a <strong>findBy</strong> named method, that will be also implemented for us.</p>
  822. </div>
  823. </li>
  824. <li>
  825. <p>Next, let create a configuration that will initialize our database:</p>
  826. <div class="listingblock">
  827. <div class="title">io.pivotal.workshop.directory.config.DirectoryConfig.java</div>
  828. <div class="content">
  829. <pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@Configuration</span>
  830. <span class="directive">public</span> <span class="type">class</span> <span class="class">DirectoryConfig</span> <span class="directive">extends</span> WebMvcConfigurerAdapter {
  831. <span class="annotation">@Override</span>
  832. <span class="directive">public</span> <span class="type">void</span> addViewControllers(ViewControllerRegistry registry) {
  833. registry.addViewController(<span class="string"><span class="delimiter">&quot;</span><span class="content">/</span><span class="delimiter">&quot;</span></span>).setViewName(<span class="string"><span class="delimiter">&quot;</span><span class="content">views/home</span><span class="delimiter">&quot;</span></span>);
  834. }
  835. <span class="annotation">@Bean</span>
  836. <span class="directive">public</span> CommandLineRunner directoryProcess(PersonRepository repo) {
  837. <span class="keyword">return</span> args -&gt; {
  838. repo.save(<span class="keyword">new</span> Person(<span class="string"><span class="delimiter">&quot;</span><span class="content">admin</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">Administrator</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">admin</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">1980-08-22</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">ADMIN</span><span class="delimiter">&quot;</span></span>, <span class="predefined-constant">true</span>));
  839. repo.save(<span class="keyword">new</span> Person(<span class="string"><span class="delimiter">&quot;</span><span class="content">john@email.com</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">John C.</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">simplepwd</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">1980-08-03</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">USER</span><span class="delimiter">&quot;</span></span>, <span class="predefined-constant">true</span>));
  840. repo.save(<span class="keyword">new</span> Person(<span class="string"><span class="delimiter">&quot;</span><span class="content">mike@email.com</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">Mike H.</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">simplepwd</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">1980-04-10</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">USER</span><span class="delimiter">&quot;</span></span>, <span class="predefined-constant">true</span>));
  841. repo.save(<span class="keyword">new</span> Person(<span class="string"><span class="delimiter">&quot;</span><span class="content">mark@email.com</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">Mark S.</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">simplepwd</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">1981-10-08</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">USER</span><span class="delimiter">&quot;</span></span>, <span class="predefined-constant">true</span>));
  842. repo.save(<span class="keyword">new</span> Person(<span class="string"><span class="delimiter">&quot;</span><span class="content">dan@email.com</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">Dan B.</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">simplepwd</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">1981-10-08</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">ACTUATOR</span><span class="delimiter">&quot;</span></span>, <span class="predefined-constant">true</span>));
  843. };
  844. }
  845. }</code></pre>
  846. </div>
  847. </div>
  848. <div class="paragraph">
  849. <p>As you can see we are extending from <strong>WebMvcConfigurerAdapter</strong> and the purpose of this is to configure our home page (or view) by overriding the <strong>addViewControllers</strong> method (this is another way to configure a web controller).</p>
  850. </div>
  851. </li>
  852. <li>
  853. <p>We need to add our own security based on the <strong>Person</strong> class. Let&#8217;s add the security configuration. Create the <strong>DirectorySecurityConfig</strong> class:</p>
  854. <div class="listingblock">
  855. <div class="title">io.pivotal.workshop.directory.config.DirectorySecurityConfig.java</div>
  856. <div class="content">
  857. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.config</span>;
  858. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.security.DirectoryUserDetailsService</span>;
  859. <span class="keyword">import</span> <span class="include">org.springframework.boot.actuate.autoconfigure.security.EndpointRequest</span>;
  860. <span class="keyword">import</span> <span class="include">org.springframework.boot.autoconfigure.security.StaticResourceRequest</span>;
  861. <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Configuration</span>;
  862. <span class="keyword">import</span> <span class="include">org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder</span>;
  863. <span class="keyword">import</span> <span class="include">org.springframework.security.config.annotation.web.builders.HttpSecurity</span>;
  864. <span class="keyword">import</span> <span class="include">org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter</span>;
  865. <span class="annotation">@Configuration</span>
  866. <span class="directive">public</span> <span class="type">class</span> <span class="class">DirectorySecurityConfig</span> <span class="directive">extends</span> WebSecurityConfigurerAdapter{
  867. <span class="directive">private</span> DirectoryUserDetailsService userDetailsService;
  868. <span class="directive">public</span> DirectorySecurityConfig(DirectoryUserDetailsService userDetailsService){
  869. <span class="local-variable">this</span>.userDetailsService = userDetailsService;
  870. }
  871. <span class="annotation">@Override</span>
  872. <span class="directive">protected</span> <span class="type">void</span> configure(HttpSecurity http) <span class="directive">throws</span> <span class="exception">Exception</span> {
  873. http
  874. .authorizeRequests()
  875. .requestMatchers(EndpointRequest.to(<span class="string"><span class="delimiter">&quot;</span><span class="content">status</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">info</span><span class="delimiter">&quot;</span></span>))
  876. .permitAll()
  877. .requestMatchers(EndpointRequest.toAnyEndpoint())
  878. .hasRole(<span class="string"><span class="delimiter">&quot;</span><span class="content">ACTUATOR</span><span class="delimiter">&quot;</span></span>)
  879. .requestMatchers(StaticResourceRequest.toCommonLocations())
  880. .permitAll()
  881. .antMatchers(<span class="string"><span class="delimiter">&quot;</span><span class="content">/api/**</span><span class="delimiter">&quot;</span></span>).hasRole(<span class="string"><span class="delimiter">&quot;</span><span class="content">ADMIN</span><span class="delimiter">&quot;</span></span>)
  882. .antMatchers(<span class="string"><span class="delimiter">&quot;</span><span class="content">/</span><span class="delimiter">&quot;</span></span>).permitAll()
  883. .and()
  884. .formLogin();
  885. }
  886. <span class="annotation">@Override</span>
  887. <span class="directive">public</span> <span class="type">void</span> configure(AuthenticationManagerBuilder auth) <span class="directive">throws</span> <span class="exception">Exception</span> {
  888. auth.userDetailsService(<span class="local-variable">this</span>.userDetailsService);
  889. }
  890. }</code></pre>
  891. </div>
  892. </div>
  893. <div class="paragraph">
  894. <p>As you can see we are extending from <strong>WebSecurityConfigurerAdapter</strong> and it give us a way to override some methods,
  895. in this case the <strong>configure(HttpSecurity)</strong> (that provides an easy way to configure the request access)
  896. and <strong>configure(AuthenticationManagerBuilder</strong> (where we are adding our custom secured service, in this case the <strong>UserDetailsService</strong>).</p>
  897. </div>
  898. </li>
  899. <li>
  900. <p>Next, create the <strong>DirectoryUserDetailsService</strong> class that will have our custom access to our own schema:</p>
  901. <div class="listingblock">
  902. <div class="title">io.pivotal.workshop.directory.security.DirectoryUserDetailsService.java</div>
  903. <div class="content">
  904. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.security</span>;
  905. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.domain.Person</span>;
  906. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.repository.PersonRepository</span>;
  907. <span class="keyword">import</span> <span class="include">org.springframework.security.core.userdetails.User</span>;
  908. <span class="keyword">import</span> <span class="include">org.springframework.security.core.userdetails.UserDetails</span>;
  909. <span class="keyword">import</span> <span class="include">org.springframework.security.core.userdetails.UserDetailsService</span>;
  910. <span class="keyword">import</span> <span class="include">org.springframework.security.core.userdetails.UsernameNotFoundException</span>;
  911. <span class="keyword">import</span> <span class="include">org.springframework.stereotype.Component</span>;
  912. <span class="annotation">@Component</span>
  913. <span class="directive">public</span> <span class="type">class</span> <span class="class">DirectoryUserDetailsService</span> <span class="directive">implements</span> UserDetailsService {
  914. <span class="directive">private</span> PersonRepository repo;
  915. <span class="directive">public</span> DirectoryUserDetailsService(PersonRepository repo) {
  916. <span class="local-variable">this</span>.repo = repo;
  917. }
  918. <span class="annotation">@Override</span>
  919. <span class="directive">public</span> UserDetails loadUserByUsername(<span class="predefined-type">String</span> username) <span class="directive">throws</span> UsernameNotFoundException {
  920. <span class="keyword">try</span> {
  921. <span class="directive">final</span> Person person = <span class="local-variable">this</span>.repo.findByEmailIgnoreCase(username);
  922. <span class="keyword">return</span> User.withDefaultPasswordEncoder().username(person.getEmail()).password(person.getPassword()).roles(person.getRole()).build();
  923. }<span class="keyword">catch</span>(<span class="exception">Exception</span> ex){
  924. ex.printStackTrace();
  925. <span class="keyword">throw</span> <span class="keyword">new</span> UsernameNotFoundException(username);
  926. }
  927. }
  928. }</code></pre>
  929. </div>
  930. </div>
  931. <div class="paragraph">
  932. <p>In this class we are including the <strong>PersonRepository</strong> and we are using the <strong>findByEmail</strong> method.
  933. See that we are implementing the <strong>UserDetailsService</strong> interface and we are implementing the <strong>loadUserByUsername</strong> that returns a <strong>UserDetails</strong>.</p>
  934. </div>
  935. </li>
  936. <li>
  937. <p>Next, open the <strong>src/main/resources/application.properties</strong> file and add/modify it to look like the following:</p>
  938. <div class="listingblock">
  939. <div class="title">src/main/resources/application.properties</div>
  940. <div class="content">
  941. <pre class="CodeRay highlight"><code data-lang="properties">## Server
  942. server.port=${port:8585}
  943. ## REST
  944. spring.data.rest.base-path=api
  945. ## ACTUATOR
  946. management.context-path=/admin
  947. ## JPA
  948. spring.jpa.generate-ddl=true
  949. spring.jpa.hibernate.ddl-auto=create-drop</code></pre>
  950. </div>
  951. </div>
  952. <div class="paragraph">
  953. <p>As you can see, all these properties are well known from previous labs. The Rest repository is exposed in the <strong>/api</strong> endpoint and the <strong>spring-boot-actuator</strong> endpoint at the <strong>/admin</strong> context-path.</p>
  954. </div>
  955. </li>
  956. <li>
  957. <p>Add the necessary UI, remember where? Here are the files you need:</p>
  958. <div class="ulist">
  959. <ul>
  960. <li>
  961. <p><a href="artifacts/spring-boot-security/theme.html" target="_blank">theme.css</a></p>
  962. </li>
  963. <li>
  964. <p><a href="artifacts/spring-boot-security/offcanvas.html" target="_blank">offcanvas.css</a></p>
  965. </li>
  966. <li>
  967. <p><a href="artifacts/spring-boot-security/main.html" target="_blank">main.tpl</a></p>
  968. </li>
  969. <li>
  970. <p><a href="artifacts/spring-boot-security/home.html" target="_blank">home.tpl</a></p>
  971. </li>
  972. </ul>
  973. </div>
  974. </li>
  975. <li>
  976. <p>Don&#8217;t forget to add the necessary dependencies in your <strong>pom.xml</strong> or <strong>build.gradle</strong>.</p>
  977. <div class="listingblock">
  978. <div class="title">pom.xml</div>
  979. <div class="content">
  980. <pre class="CodeRay highlight"><code data-lang="xml"><span class="tag">&lt;dependency&gt;</span>
  981. <span class="tag">&lt;groupId&gt;</span>org.webjars<span class="tag">&lt;/groupId&gt;</span>
  982. <span class="tag">&lt;artifactId&gt;</span>jquery<span class="tag">&lt;/artifactId&gt;</span>
  983. <span class="tag">&lt;version&gt;</span>2.2.4<span class="tag">&lt;/version&gt;</span>
  984. <span class="tag">&lt;/dependency&gt;</span>
  985. <span class="tag">&lt;dependency&gt;</span>
  986. <span class="tag">&lt;groupId&gt;</span>org.webjars<span class="tag">&lt;/groupId&gt;</span>
  987. <span class="tag">&lt;artifactId&gt;</span>bootstrap<span class="tag">&lt;/artifactId&gt;</span>
  988. <span class="tag">&lt;version&gt;</span>3.3.6<span class="tag">&lt;/version&gt;</span>
  989. <span class="tag">&lt;/dependency&gt;</span>
  990. <span class="tag">&lt;dependency&gt;</span>
  991. <span class="tag">&lt;groupId&gt;</span>org.webjars<span class="tag">&lt;/groupId&gt;</span>
  992. <span class="tag">&lt;artifactId&gt;</span>angularjs<span class="tag">&lt;/artifactId&gt;</span>
  993. <span class="tag">&lt;version&gt;</span>1.5.7<span class="tag">&lt;/version&gt;</span>
  994. <span class="tag">&lt;/dependency&gt;</span></code></pre>
  995. </div>
  996. </div>
  997. <div class="listingblock">
  998. <div class="title">build.gradle</div>
  999. <div class="content">
  1000. <pre class="CodeRay highlight"><code data-lang="groovy">compile(<span class="string"><span class="delimiter">'</span><span class="content">org.webjars:jquery:2.2.4</span><span class="delimiter">'</span></span>)
  1001. compile(<span class="string"><span class="delimiter">'</span><span class="content">org.webjars:bootstrap:3.3.6</span><span class="delimiter">'</span></span>)
  1002. compile(<span class="string"><span class="delimiter">'</span><span class="content">org.webjars:angularjs:1.5.7</span><span class="delimiter">'</span></span>)</code></pre>
  1003. </div>
  1004. </div>
  1005. </li>
  1006. <li>
  1007. <p>Run the application, either command line or through your IDE. If you go to the <a href="http://localhost:8585" class="bare" target="_blank">http://localhost:8585</a> in your browser, you should get the same as the following Figure 2.0:</p>
  1008. <div class="paragraph">
  1009. <div class="title">Figure 2.0: Directory Web Security App - <a href="http://localhost:8585" class="bare" target="_blank">http://localhost:8585</a></div>
  1010. <p><span class="image"><img src="images/09-spring-boot-security-02.png" alt="Directory Web Security App" title="Directory Web Security App"></span></p>
  1011. </div>
  1012. </li>
  1013. <li>
  1014. <p>If you try to go to the <a href="http://localhost:8585/api" class="bare" target="_blank">http://localhost:8585/api</a>, you should get the following Figure 3.0:</p>
  1015. <div class="paragraph">
  1016. <div class="title">Figure 3.0: Directory Web Security App Login - <a href="http://localhost:8585/api" class="bare" target="_blank">http://localhost:8585/api</a></div>
  1017. <p><span class="image"><img src="images/09-spring-boot-security-03.png" alt="Directory Web Security App" title="Directory Web Security App"></span></p>
  1018. </div>
  1019. <div class="paragraph">
  1020. <p>You can now use one of the persons we added in the configurations, for example use: <strong>admin</strong> and <strong>admin</strong> as password, and you should get now the <strong>Person Repository Rest API</strong> response.</p>
  1021. </div>
  1022. </li>
  1023. </ol>
  1024. </div>
  1025. <div class="admonitionblock tip">
  1026. <table>
  1027. <tr>
  1028. <td class="icon">
  1029. <div class="title">Tip</div>
  1030. </td>
  1031. <td class="content">
  1032. If by any reason during the testing in your browser you get the <strong>"403 - Forbidden error"</strong>, try to remove the <strong>CACHE</strong> from your browser. Remember that you can still use a <code>curl</code> command or if you are a Windows user, you can use <strong>POSTMAN</strong> <a href="https://www.getpostman.com/" class="bare" target="_blank">https://www.getpostman.com/</a>.
  1033. </td>
  1034. </tr>
  1035. </table>
  1036. </div>
  1037. </div>
  1038. </div>
  1039. <div class="sect1">
  1040. <h2 id="_code_snippet_manager_security">Code Snippet Manager Security</h2>
  1041. <div class="sectionbody">
  1042. <div class="paragraph">
  1043. <p>The purpose of this Lab is to add <strong><em>security</em></strong> to your <strong>Code Snippet Manager</strong> and prepare it for the <strong>Challenges</strong>. The idea is that the <strong>Code Snippet Manager</strong> will use the <strong>directory-web-security</strong> to authenticate to use the snippet <strong>/api</strong>.</p>
  1044. </div>
  1045. <div class="paragraph">
  1046. <p>You will reuse the code from the <strong>code-snippet-manager-actuator</strong> project.</p>
  1047. </div>
  1048. <div class="olist arabic">
  1049. <ol class="arabic">
  1050. <li>
  1051. <p>Open a browser and hit the url: <a href="http://start.spring.io" class="bare" target="_blank">http://start.spring.io</a></p>
  1052. </li>
  1053. <li>
  1054. <p>Click the <strong><em>Switch to the full version</em></strong> link.</p>
  1055. </li>
  1056. <li>
  1057. <p>Fill out the Code Snippet Manager Security Project metadata with (See Figure 1.0):</p>
  1058. <table class="tableblock frame-all grid-all spread">
  1059. <caption class="title">Table 2. Code Snippet Manager Security App - metadata</caption>
  1060. <colgroup>
  1061. <col style="width: 16.6666%;">
  1062. <col style="width: 83.3334%;">
  1063. </colgroup>
  1064. <thead>
  1065. <tr>
  1066. <th class="tableblock halign-left valign-top">Property</th>
  1067. <th class="tableblock halign-left valign-top">Value</th>
  1068. </tr>
  1069. </thead>
  1070. <tbody>
  1071. <tr>
  1072. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Group</strong>:</p></td>
  1073. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>io.pivotal.workshop</em></p></td>
  1074. </tr>
  1075. <tr>
  1076. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Artifact</strong>:</p></td>
  1077. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>code-snippet-manager-security</em></p></td>
  1078. </tr>
  1079. <tr>
  1080. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Name</strong>:</p></td>
  1081. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>code-snippet-manager-security</em></p></td>
  1082. </tr>
  1083. <tr>
  1084. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Package Name</strong>:</p></td>
  1085. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>io.pivotal.workshop.snippet</em></p></td>
  1086. </tr>
  1087. <tr>
  1088. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Dependencies</strong>:</p></td>
  1089. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>Web</em>, <em>DevTools</em>, <em>H2</em>, <em>MySQL</em>, <em>Security</em>, <em>JPA</em>, <em>Rest Repositories</em>, <em>Actuator</em>, <em>HATEOAS</em>, <em>Groovy Templates</em></p></td>
  1090. </tr>
  1091. <tr>
  1092. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Spring Boot</strong>:</p></td>
  1093. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>2.0.0.M7</em></p></td>
  1094. </tr>
  1095. </tbody>
  1096. </table>
  1097. <div class="paragraph">
  1098. <div class="title">Figure 1.0: Spring Initializr - <a href="http://start.spring.io" class="bare" target="_blank">http://start.spring.io</a></div>
  1099. <p><span class="image"><img src="images/09-spring-boot-security-xx.png" alt="SpringInitializr" title="Spring Initializr"></span></p>
  1100. </div>
  1101. <div class="admonitionblock tip">
  1102. <table>
  1103. <tr>
  1104. <td class="icon">
  1105. <div class="title">Tip</div>
  1106. </td>
  1107. <td class="content">
  1108. You can choose either <strong>Maven</strong> or <strong>Gradle</strong> project types.
  1109. </td>
  1110. </tr>
  1111. </table>
  1112. </div>
  1113. </li>
  1114. <li>
  1115. <p>Type <strong>Web</strong>, <strong>DevTools</strong>, <strong>H2</strong>, <strong>MySQL</strong>, <strong>Security</strong>, <strong>JPA</strong>, <strong>Rest Repositories</strong>, <strong>Actuator</strong>, <strong>HATEOAS</strong> and <strong>Groovy Templates</strong> in the <strong><em>Dependencies</em></strong> field and press Enter.</p>
  1116. </li>
  1117. <li>
  1118. <p>Click the <strong><em>Generate Project</em></strong> button.</p>
  1119. </li>
  1120. <li>
  1121. <p>Unzip the file in any directory you want.</p>
  1122. </li>
  1123. <li>
  1124. <p>Import your project in any IDE you want.</p>
  1125. </li>
  1126. <li>
  1127. <p>Copy all the code from <strong>code-snippet-manager-actuator</strong></p>
  1128. </li>
  1129. <li>
  1130. <p>Create a <strong>io.pivotal.workshop.snippet.domain.Person</strong> class. This will be use for using the <strong>directory-web-security</strong> domain.</p>
  1131. <div class="listingblock">
  1132. <div class="title">/src/main/java/io/pivota/workshop/snippet/domain/Person.java</div>
  1133. <div class="content">
  1134. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.snippet.domain</span>;
  1135. <span class="keyword">import</span> <span class="include">com.fasterxml.jackson.annotation.JsonIgnoreProperties</span>;
  1136. <span class="annotation">@JsonIgnoreProperties</span>(ignoreUnknown = <span class="predefined-constant">true</span>)
  1137. <span class="directive">public</span> <span class="type">class</span> <span class="class">Person</span> {
  1138. <span class="directive">private</span> <span class="predefined-type">String</span> email;
  1139. <span class="directive">private</span> <span class="predefined-type">String</span> password;
  1140. <span class="directive">private</span> <span class="predefined-type">String</span> role;
  1141. <span class="directive">public</span> <span class="predefined-type">String</span> getEmail() {
  1142. <span class="keyword">return</span> email;
  1143. }
  1144. <span class="directive">public</span> <span class="type">void</span> setEmail(<span class="predefined-type">String</span> email) {
  1145. <span class="local-variable">this</span>.email = email;
  1146. }
  1147. <span class="directive">public</span> <span class="predefined-type">String</span> getPassword() {
  1148. <span class="keyword">return</span> password;
  1149. }
  1150. <span class="directive">public</span> <span class="type">void</span> setPassword(<span class="predefined-type">String</span> password) {
  1151. <span class="local-variable">this</span>.password = password;
  1152. }
  1153. <span class="directive">public</span> <span class="predefined-type">String</span> getRole() {
  1154. <span class="keyword">return</span> role;
  1155. }
  1156. <span class="directive">public</span> <span class="type">void</span> setRole(<span class="predefined-type">String</span> role) {
  1157. <span class="local-variable">this</span>.role = role;
  1158. }
  1159. }</code></pre>
  1160. </div>
  1161. </div>
  1162. <div class="admonitionblock tip">
  1163. <table>
  1164. <tr>
  1165. <td class="icon">
  1166. <div class="title">Tip</div>
  1167. </td>
  1168. <td class="content">
  1169. You can get all the <strong>templates</strong>, <strong>css</strong> and <strong>js</strong> files from other projects.
  1170. </td>
  1171. </tr>
  1172. </table>
  1173. </div>
  1174. </li>
  1175. <li>
  1176. <p>That&#8217;s it, just preparing the <strong>code-snippet-manager</strong> for the <strong>Challenges</strong></p>
  1177. </li>
  1178. </ol>
  1179. </div>
  1180. <div class="sect2">
  1181. <h3 id="_challenges">Challenges</h3>
  1182. <div class="ulist">
  1183. <ul>
  1184. <li>
  1185. <p>Make sure you have access to the <strong>/admin/health</strong> actuator endpoint in the <strong>directory-web-security</strong> project. Use the user that has the role <strong>ACTUATOR</strong>.</p>
  1186. </li>
  1187. <li>
  1188. <p>Make the <strong>HOME PAGE</strong> is only reachable to users with role <strong>USER</strong> in the <strong>directory-web-security</strong> project*.</p>
  1189. </li>
  1190. <li>
  1191. <p>Modify the <strong>code-snippet-manager-security</strong> project and use the <strong>directory-web-security</strong> project as authentication authority.</p>
  1192. </li>
  1193. </ul>
  1194. </div>
  1195. </div>
  1196. </div>
  1197. </div>
  1198. <div class="sect1">
  1199. <h2 id="_homework">HOMEWORK</h2>
  1200. <div class="sectionbody">
  1201. <div class="ulist">
  1202. <ul>
  1203. <li>
  1204. <p>Add SSL to both projects.</p>
  1205. </li>
  1206. </ul>
  1207. </div>
  1208. </div>
  1209. </div>
  1210. </div>
  1211. <div id="footer">
  1212. <div id="footer-text">
  1213. Last updated 2017-11-28 14:47:44 PST
  1214. </div>
  1215. </div>
  1216. </body>
  1217. </html>