├── .github └── ISSUE_TEMPLATE.md ├── .gitignore ├── .travis.yml ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── COPYING ├── GETTING-STARTED.md ├── LICENSE ├── README.md ├── build.config.js ├── package.json ├── pom.xml ├── src ├── deb │ └── control │ │ └── control ├── main │ ├── java │ │ └── org │ │ │ └── graylog │ │ │ └── plugins │ │ │ └── auth │ │ │ └── sso │ │ │ ├── SsoAuthConfig.java │ │ │ ├── SsoAuthMetaData.java │ │ │ ├── SsoAuthModule.java │ │ │ ├── SsoAuthPermissions.java │ │ │ ├── SsoAuthPlugin.java │ │ │ ├── SsoAuthRealm.java │ │ │ ├── SsoConfigResource.java │ │ │ └── audit │ │ │ └── SsoAuthAuditEventTypes.java │ └── resources │ │ ├── META-INF │ │ └── services │ │ │ └── org.graylog2.plugin.Plugin │ │ └── org.graylog.plugins.graylog-plugin-auth-sso │ │ └── graylog-plugin.properties ├── test │ └── java │ │ └── org │ │ └── graylog │ │ └── plugins │ │ └── auth │ │ └── sso │ │ └── SsoAuthRealmTest.java └── web │ ├── SsoAuthActions.jsx │ ├── SsoAuthStore.jsx │ ├── SsoConfiguration.jsx │ └── index.jsx ├── webpack.config.js └── yarn.lock /.github/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ### Problem description 2 | 3 | ### Steps to reproduce the problem 4 | 5 | 1. ... 6 | 7 | ### Environment 8 | 9 | * Graylog Version: 10 | * Plugin Version: 11 | * Elasticsearch Version: 12 | * MongoDB Version: 13 | * Operating System: 14 | * Browser version: 15 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | *.iml 3 | *.ipr 4 | *.iws 5 | .classpath 6 | .project 7 | .settings/ 8 | target/ 9 | dependency-reduced-pom.xml 10 | node_modules 11 | node 12 | build 13 | build.config.js.sample 14 | cache/ 15 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: required 2 | dist: trusty 3 | language: java 4 | jdk: 5 | - oraclejdk8 6 | addons: 7 | apt: 8 | packages: 9 | - rpm 10 | install: 11 | - git clone --branch 3.3 --depth=1 --no-single-branch https://github.com/Graylog2/graylog2-server ../graylog2-server 12 | - (cd ../graylog2-server && mvn -DskipTests=true compile -B -V) 13 | - mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dskip.web.build=true -B -V 14 | script: 15 | - mvn package -B 16 | before_deploy: 17 | - mvn jdeb:jdeb && export RELEASE_DEB_FILE=$(ls target/*.deb) 18 | - mvn rpm:rpm && export RELEASE_RPM_FILE=$(find target/ -name '*.rpm' | tail -1) 19 | - rm -f target/original-*.jar 20 | - export RELEASE_PKG_FILE=$(ls target/*.jar) 21 | - echo "Deploying release to GitHub releases" 22 | deploy: 23 | provider: releases 24 | api_key: 25 | secure: o4aGEYiU3qxIWaMFadlC6bMYYNo0sPKBgoDV4OjVH5hAn4Z8oujSsRrC9uIVbi8uh0LImx5z0KqgRAtBq+zCvXt39CFj6ZN9HqziOhJPVnXob/LUFu8ZdrHvDFNUP5tfJ49CuKoJX0j43QZVCqREiUD+BhQIKYVRS2OvEFFHYr4L2KA4LwTk+YP3nPov70sCyY8X824Yx4E0fcQD8mqTUj9YE2CdOH3EaULTXM6+xjBP47WdpdNwU3Qafxsncy2Mms0yGJ8dpMdz8XOAfRR6oyANtZQOLJ5zn23KL3AvLeqqkLD32olGxg9FzHqGtptXXkvpuRQ3GFun1r0KCyCsAXe4vkUPxYPp0UkaHFkIVVHa6PoNX3CqZ2KTAwKNj3/0lFL6Bbr1q8rcw6PJucnwsdXmuRS+ofWVvk0AZN7iQlfeIBzLgqGdb/hcU5SzSV9ne4in2jHOAgY29ZEGKSi5yaSwSgaU+OUurpXRGvByxvYgJKyybIkfUGiHy0anZ+MvO7/XGR0d28d00jFhXrA1d4cT0DMUNp8+uoJNFIs6MjOiHOUprPifkGI+1jpDIR2BUR6NEkChfWvzzmyZtbLy7zQN+ddc6AKvJ7Z7Vz5K07i7ATQslwLMp9fKOa4Fw9dcCT2CBi5kXuTpY5jkZIw0sFzoDZJRP7b18Uwv7V2ky8o= 26 | file: 27 | - "${RELEASE_PKG_FILE}" 28 | - "${RELEASE_DEB_FILE}" 29 | - "${RELEASE_RPM_FILE}" 30 | skip_cleanup: true 31 | on: 32 | tags: true 33 | jdk: oraclejdk8 34 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, gender identity and expression, level of experience, 9 | nationality, personal appearance, race, religion, or sexual identity and 10 | orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at . All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at [http://contributor-covenant.org/version/1/4][version] 72 | 73 | [homepage]: http://contributor-covenant.org 74 | [version]: http://contributor-covenant.org/version/1/4/ 75 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | Please follow [the instructions on graylog.org](https://www.graylog.org/contributing-to-graylog/). 2 | 3 | #### Code of Conduct 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, gender identity and expression, level of experience, 9 | nationality, personal appearance, race, religion, or sexual identity and 10 | orientation. 11 | 12 | Please read and understand the [Code of Conduct](https://github.com/Graylog2/graylog-plugin-map-widget/blob/master/CODE_OF_CONDUCT.md). 13 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /GETTING-STARTED.md: -------------------------------------------------------------------------------- 1 | Getting started with your new Graylog plugin 2 | ============================================ 3 | 4 | Welcome to your new Graylog plugin! 5 | 6 | Please refer to http://docs.graylog.org/en/latest/pages/plugins.html for documentation on how to write 7 | plugins for Graylog. 8 | 9 | Travis CI 10 | --------- 11 | 12 | There is a `.travis.yml` template in this project which is prepared to automatically 13 | deploy the plugin artifacts (JAR, DEB, RPM) to GitHub releases. 14 | 15 | You just have to add your encrypted GitHub access token to the `.travis.yml`. 16 | The token can be generated in your [GitHub personal access token settings](https://github.com/settings/tokens). 17 | 18 | Before Travis CI works, you have to enable it. Install the Travis CI command line 19 | application and execute `travis enable`. 20 | 21 | To encrypt your GitHub access token you can use `travis encrypt`. 22 | 23 | Alternatively you can use `travis setup -f releases` to automatically create a GitHub 24 | access token and add it to the `.travis.yml` file. **Attention:** doing this 25 | will replace some parts of the `.travis.yml` file and you have to restore previous 26 | settings. 27 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | See the COPYING file for license information 2 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Note 2 | 3 | This plugin no longer works in recent Graylog versions and is archived. It is provided only for historical purposes in case someone needs access to the source code. 4 | 5 | # SSO Authentication Plugin for Graylog 6 | 7 | [![Build Status](https://travis-ci.org/Graylog2/graylog-plugin-auth-sso.svg?branch=master)](https://travis-ci.org/Graylog2/graylog-plugin-auth-sso) 8 | 9 | This plugins adds SSO (Single Sign-On) capabilities to Graylog. It supports automatic login and user account creation based on trusted HTTP headers set by an authentication proxy. 10 | 11 | 12 | **Required Graylog version:** 3.3.x. 13 | 14 | **This plugin will not be compatible with Graylog 4.0 and later!** 15 | 16 | Version Compatibility 17 | --------------------- 18 | 19 | | Plugin Version | Graylog Version | 20 | | -------------- | --------------- | 21 | | 3.3.x | 3.3.x | 22 | | 3.2.x | 3.2.x | 23 | | 3.1.x | 3.1.x | 24 | | 3.0.x | 3.0.x | 25 | | 2.5.x | 2.5.x | 26 | | 2.4.x | 2.4.x | 27 | | 2.3.x | 2.3.x | 28 | | 1.0.x | >=2.1.x, <2.3.x | 29 | 30 | Installation 31 | ------------ 32 | 33 | [Download the plugin](https://github.com/Graylog2/graylog-plugin-auth-sso/releases) 34 | and place the `.jar` file in your Graylog plugin directory. The plugin directory 35 | is the `plugins/` folder relative from your `graylog-server` directory by default 36 | and can be configured in your `graylog.conf` file. 37 | 38 | Restart `graylog-server` and you are done. 39 | 40 | Development 41 | ----------- 42 | 43 | You can improve your development experience for the web interface part of your plugin 44 | dramatically by making use of hot reloading. To do this, do the following: 45 | 46 | * `git clone https://github.com/Graylog2/graylog2-server.git` 47 | * `cd graylog2-server/graylog2-web-interface` 48 | * `ln -s $YOURPLUGIN plugin/` 49 | * `npm install && npm start` 50 | 51 | Usage 52 | ----- 53 | 54 | How this Plugin can be used is described in [the Graylog Documentation](http://docs.graylog.org/en/latest/pages/users_and_roles/external_auth.html#single-sign-on) 55 | 56 | 57 | Getting started 58 | --------------- 59 | 60 | This project is using Maven 3 and requires Java 8 or higher. 61 | 62 | * Clone this repository. 63 | * Run `mvn package` to build a JAR file. 64 | * Optional: Run `mvn jdeb:jdeb` and `mvn rpm:rpm` to create a DEB and RPM package respectively. 65 | * Copy generated JAR file in target directory to your Graylog plugin directory. 66 | * Restart the Graylog. 67 | 68 | Plugin Release 69 | -------------- 70 | 71 | - Bump version in `package.json` 72 | - Bump parent version and `graylog.version` in pom.xml 73 | - Change branch name for the graylog2-server checkout in `.travis.yml` 74 | 75 | For the rest we are using the maven release plugin: 76 | 77 | ``` 78 | $ mvn release:prepare 79 | ``` 80 | 81 | (no need for `mvn release:perform`) 82 | 83 | This sets the version numbers, creates a tag and pushes to GitHub. Travis CI will build the release artifacts and upload to GitHub automatically. 84 | -------------------------------------------------------------------------------- /build.config.js: -------------------------------------------------------------------------------- 1 | const path = require('path'); 2 | 3 | module.exports = { 4 | // Make sure that this is the correct path to the web interface part of the Graylog server repository. 5 | web_src_path: path.resolve(__dirname, '../graylog2-server/graylog2-web-interface'), 6 | }; 7 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "SsoAuthPlugin", 3 | "version": "3.3.0", 4 | "description": "", 5 | "repository": { 6 | "type": "git", 7 | "url": "https://github.com/Graylog2/graylog-plugin-auth-sso" 8 | }, 9 | "scripts": { 10 | "build": "webpack --bail" 11 | }, 12 | "keywords": [ 13 | "graylog" 14 | ], 15 | "author": "Kay Roepke ", 16 | "license": "MIT", 17 | "dependencies": { 18 | }, 19 | "devDependencies": { 20 | "graylog-web-plugin": "file:../graylog2-server/graylog2-web-interface/packages/graylog-web-plugin" 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | 5 | 3.1 6 | 7 | 8 | 9 | org.graylog.plugins 10 | graylog-plugin-web-parent 11 | 3.3.0 12 | ../graylog2-server/graylog-plugin-parent/graylog-plugin-web-parent 13 | 14 | 15 | graylog-plugin-auth-sso 16 | 3.3.1-SNAPSHOT 17 | jar 18 | 19 | ${project.artifactId} 20 | Graylog SSO authentication plugin. 21 | https://www.graylog.org 22 | 23 | 24 | 25 | Kay Roepke 26 | kay@graylog.com 27 | 28 | 29 | 30 | 31 | scm:git:git@github.com:Graylog2/graylog-plugin-auth-sso.git 32 | scm:git:git@github.com:Graylog2/graylog-plugin-auth-sso.git 33 | https://github.com/Graylog2/graylog-plugin-auth-sso 34 | HEAD 35 | 36 | 37 | 38 | 3.3.0 39 | 40 | 41 | 42 | 43 | org.graylog2 44 | graylog2-server 45 | ${graylog.version} 46 | provided 47 | 48 | 49 | com.google.auto.value 50 | auto-value 51 | ${auto-value.version} 52 | provided 53 | 54 | 55 | 56 | junit 57 | junit 58 | ${junit.version} 59 | test 60 | 61 | 62 | org.assertj 63 | assertj-core 64 | ${assertj-core.version} 65 | test 66 | 67 | 68 | org.mockito 69 | mockito-core 70 | ${mockito.version} 71 | test 72 | 73 | 74 | 75 | 76 | 77 | 78 | ${web.build-dir} 79 | 80 | 81 | src/main/resources 82 | true 83 | 84 | 85 | 86 | 87 | maven-assembly-plugin 88 | 89 | true 90 | 91 | 92 | 93 | org.apache.maven.plugins 94 | maven-shade-plugin 95 | 96 | false 97 | 98 | 99 | 100 | package 101 | 102 | shade 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | org.apache.maven.plugins 115 | maven-compiler-plugin 116 | 117 | false 118 | 119 | com.google.auto.value.processor.AutoValueProcessor 120 | 121 | 122 | 123 | 124 | 125 | org.apache.maven.plugins 126 | maven-release-plugin 127 | 128 | true 129 | forked-path 130 | @{project.version} 131 | clean test 132 | package 133 | 134 | 135 | 136 | 137 | jdeb 138 | org.vafer 139 | 140 | ${project.build.directory}/${project.artifactId}-${project.version}.deb 141 | 142 | 143 | ${project.build.directory}/${project.build.finalName}.jar 144 | file 145 | 146 | perm 147 | ${graylog.plugin-dir} 148 | 644 149 | root 150 | root 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | com.mycila 159 | license-maven-plugin 160 | 161 |
com/mycila/maven/plugin/license/templates/GPL-3.txt
162 | 163 | ${project.organization.name} 164 | Graylog Archive 165 | 166 | 167 | **/src/main/java/** 168 | **/src/test/java/** 169 | 170 | 171 | 172 | 173 | 174 | check 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | -------------------------------------------------------------------------------- /src/deb/control/control: -------------------------------------------------------------------------------- 1 | Package: [[name]] 2 | Version: [[version]] 3 | Architecture: all 4 | Maintainer: Kay Roepke 5 | Section: web 6 | Priority: optional 7 | Depends: graylog-server | graylog-radio 8 | Description: [[description]] 9 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/auth/sso/SsoAuthConfig.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Archive. 3 | * 4 | * Graylog Archive is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Archive is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Archive. If not, see . 16 | */ 17 | package org.graylog.plugins.auth.sso; 18 | 19 | import com.fasterxml.jackson.annotation.JsonAutoDetect; 20 | import com.fasterxml.jackson.annotation.JsonProperty; 21 | import com.fasterxml.jackson.databind.annotation.JsonDeserialize; 22 | import com.google.auto.value.AutoValue; 23 | 24 | import javax.annotation.Nullable; 25 | import java.util.Optional; 26 | 27 | @AutoValue 28 | @JsonDeserialize(builder = AutoValue_SsoAuthConfig.Builder.class) 29 | @JsonAutoDetect 30 | public abstract class SsoAuthConfig { 31 | 32 | public static Builder builder() { 33 | return new AutoValue_SsoAuthConfig.Builder(); 34 | } 35 | 36 | public abstract Builder toBuilder(); 37 | 38 | public static SsoAuthConfig defaultConfig(String trustedProxies) { 39 | return builder() 40 | .usernameHeader("Remote-User") 41 | .autoCreateUser(true) 42 | .requireTrustedProxies(true) 43 | .trustedProxies(trustedProxies) 44 | .rolesHeader("Roles") 45 | .syncRoles(false) 46 | .build(); 47 | } 48 | 49 | @JsonProperty("username_header") 50 | public abstract String usernameHeader(); 51 | 52 | @JsonProperty("fullname_header") 53 | @Nullable 54 | public abstract String fullnameHeader(); 55 | 56 | @JsonProperty("email_header") 57 | @Nullable 58 | public abstract String emailHeader(); 59 | 60 | @JsonProperty("default_group") 61 | @Nullable 62 | public abstract String defaultGroup(); 63 | 64 | @JsonProperty("auto_create_user") 65 | public abstract boolean autoCreateUser(); 66 | 67 | @JsonProperty("require_trusted_proxies") 68 | public abstract boolean requireTrustedProxies(); 69 | 70 | @JsonProperty("trusted_proxies") 71 | @Nullable 72 | public abstract String trustedProxies(); 73 | 74 | @JsonProperty("default_email_domain") 75 | @Nullable 76 | public abstract String defaultEmailDomain(); 77 | 78 | @JsonProperty("sync_roles") 79 | public abstract boolean syncRoles(); 80 | 81 | @JsonProperty("roles_header") 82 | @Nullable 83 | public abstract String rolesHeader(); 84 | 85 | @AutoValue.Builder 86 | public static abstract class Builder { 87 | abstract SsoAuthConfig autoBuild(); 88 | 89 | public SsoAuthConfig build() { 90 | if (!syncRoles().isPresent()) { 91 | // take the default values, so we can show them in the UI without having to do a migration 92 | final SsoAuthConfig defaultConfig = defaultConfig(null); 93 | syncRoles(defaultConfig.syncRoles()); 94 | rolesHeader(defaultConfig.rolesHeader()); 95 | } 96 | return autoBuild(); 97 | } 98 | 99 | @JsonProperty("username_header") 100 | public abstract Builder usernameHeader(String usernameHeader); 101 | 102 | @JsonProperty("fullname_header") 103 | public abstract Builder fullnameHeader(@Nullable String fullnameHeader); 104 | 105 | @JsonProperty("email_header") 106 | public abstract Builder emailHeader(@Nullable String emailHeader); 107 | 108 | @JsonProperty("default_group") 109 | public abstract Builder defaultGroup(@Nullable String defaultGroup); 110 | 111 | @JsonProperty("auto_create_user") 112 | public abstract Builder autoCreateUser(boolean autoCreateUser); 113 | 114 | @JsonProperty("require_trusted_proxies") 115 | public abstract Builder requireTrustedProxies(boolean requireTrustedProxies); 116 | 117 | @JsonProperty("trusted_proxies") 118 | public abstract Builder trustedProxies(@Nullable String trustedProxies); 119 | 120 | @JsonProperty("default_email_domain") 121 | public abstract Builder defaultEmailDomain(@Nullable String defaultEmailDomain); 122 | 123 | @JsonProperty("sync_roles") 124 | public abstract Builder syncRoles(boolean syncRoles); 125 | abstract Optional syncRoles(); 126 | 127 | @JsonProperty("roles_header") 128 | public abstract Builder rolesHeader(@Nullable String rolesHeader); 129 | 130 | 131 | } 132 | } 133 | 134 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/auth/sso/SsoAuthMetaData.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Archive. 3 | * 4 | * Graylog Archive is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Archive is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Archive. If not, see . 16 | */ 17 | package org.graylog.plugins.auth.sso; 18 | 19 | import org.graylog2.plugin.PluginMetaData; 20 | import org.graylog2.plugin.ServerStatus; 21 | import org.graylog2.plugin.Version; 22 | 23 | import java.net.URI; 24 | import java.util.Collections; 25 | import java.util.Set; 26 | 27 | /** 28 | * Implement the PluginMetaData interface here. 29 | */ 30 | public class SsoAuthMetaData implements PluginMetaData { 31 | private static final String PLUGIN_PROPERTIES = "org.graylog.plugins.graylog-plugin-auth-sso/graylog-plugin.properties"; 32 | 33 | @Override 34 | public String getUniqueId() { 35 | return "org.graylog.plugins.auth.sso.SsoAuthPlugin"; 36 | } 37 | 38 | @Override 39 | public String getName() { 40 | return "Single Sign-On (SSO) Authentication Provider"; 41 | } 42 | 43 | @Override 44 | public String getAuthor() { 45 | return "Graylog, Inc"; 46 | } 47 | 48 | @Override 49 | public URI getURL() { 50 | return URI.create("https://www.graylog.org/"); 51 | } 52 | 53 | @Override 54 | public Version getVersion() { 55 | return Version.fromPluginProperties(this.getClass(), PLUGIN_PROPERTIES, "version", Version.from(0, 0, 0, "unknown")); 56 | } 57 | 58 | @Override 59 | public String getDescription() { 60 | return "SSO Authentication provider"; 61 | } 62 | 63 | @Override 64 | public Version getRequiredVersion() { 65 | return Version.fromPluginProperties(this.getClass(), PLUGIN_PROPERTIES, "graylog.version", Version.CURRENT_CLASSPATH); 66 | } 67 | 68 | @Override 69 | public Set getRequiredCapabilities() { 70 | return Collections.emptySet(); 71 | } 72 | } 73 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/auth/sso/SsoAuthModule.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Archive. 3 | * 4 | * Graylog Archive is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Archive is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Archive. If not, see . 16 | */ 17 | package org.graylog.plugins.auth.sso; 18 | 19 | import com.google.inject.Scopes; 20 | import org.graylog.plugins.auth.sso.audit.SsoAuthAuditEventTypes; 21 | import org.graylog2.plugin.PluginModule; 22 | 23 | /** 24 | * Extend the PluginModule abstract class here to add you plugin to the system. 25 | */ 26 | public class SsoAuthModule extends PluginModule { 27 | 28 | @Override 29 | protected void configure() { 30 | authenticationRealmBinder().addBinding(SsoAuthRealm.NAME).to(SsoAuthRealm.class).in(Scopes.SINGLETON); 31 | addRestResource(SsoConfigResource.class); 32 | addPermissions(SsoAuthPermissions.class); 33 | addAuditEventTypes(SsoAuthAuditEventTypes.class); 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/auth/sso/SsoAuthPermissions.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Archive. 3 | * 4 | * Graylog Archive is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Archive is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Archive. If not, see . 16 | */ 17 | package org.graylog.plugins.auth.sso; 18 | 19 | import com.google.common.collect.ImmutableSet; 20 | import org.graylog2.plugin.security.Permission; 21 | import org.graylog2.plugin.security.PluginPermissions; 22 | 23 | import java.util.Collections; 24 | import java.util.Set; 25 | 26 | import static org.graylog2.plugin.security.Permission.create; 27 | 28 | public class SsoAuthPermissions implements PluginPermissions { 29 | 30 | public static final String CONFIG_READ = "ssoauthconfig:read"; 31 | public static final String CONFIG_UPDATE = "ssoauthconfig:edit"; 32 | 33 | private final ImmutableSet permissions = ImmutableSet.of( 34 | create(CONFIG_READ, "Read SSO authenticator config"), 35 | create(CONFIG_UPDATE, "Update SSO authenticator config") 36 | ); 37 | 38 | @Override 39 | public Set permissions() { 40 | return permissions; 41 | } 42 | 43 | @Override 44 | public Set readerBasePermissions() { 45 | return Collections.emptySet(); 46 | } 47 | } 48 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/auth/sso/SsoAuthPlugin.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Archive. 3 | * 4 | * Graylog Archive is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Archive is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Archive. If not, see . 16 | */ 17 | package org.graylog.plugins.auth.sso; 18 | 19 | import org.graylog2.plugin.Plugin; 20 | import org.graylog2.plugin.PluginMetaData; 21 | import org.graylog2.plugin.PluginModule; 22 | 23 | import java.util.Collection; 24 | import java.util.Collections; 25 | 26 | public class SsoAuthPlugin implements Plugin { 27 | @Override 28 | public PluginMetaData metadata() { 29 | return new SsoAuthMetaData(); 30 | } 31 | 32 | @Override 33 | public Collection modules () { 34 | return Collections.singletonList(new SsoAuthModule()); 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/auth/sso/SsoAuthRealm.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Archive. 3 | * 4 | * Graylog Archive is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Archive is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Archive. If not, see . 16 | */ 17 | package org.graylog.plugins.auth.sso; 18 | 19 | import com.google.common.annotations.VisibleForTesting; 20 | import com.google.common.base.Joiner; 21 | import org.apache.shiro.authc.AuthenticationException; 22 | import org.apache.shiro.authc.AuthenticationInfo; 23 | import org.apache.shiro.authc.AuthenticationToken; 24 | import org.apache.shiro.authc.SimpleAccount; 25 | import org.apache.shiro.authc.credential.AllowAllCredentialsMatcher; 26 | import org.apache.shiro.realm.AuthenticatingRealm; 27 | import org.graylog2.database.NotFoundException; 28 | import org.graylog2.plugin.cluster.ClusterConfigService; 29 | import org.graylog2.plugin.database.ValidationException; 30 | import org.graylog2.plugin.database.users.User; 31 | import org.graylog2.security.realm.LdapUserAuthenticator; 32 | import org.graylog2.shared.security.HttpHeadersToken; 33 | import org.graylog2.shared.security.ShiroSecurityContext; 34 | import org.graylog2.shared.users.Role; 35 | import org.graylog2.shared.users.UserService; 36 | import org.graylog2.users.RoleService; 37 | import org.graylog2.utilities.IpSubnet; 38 | import org.slf4j.Logger; 39 | import org.slf4j.LoggerFactory; 40 | 41 | import javax.annotation.Nullable; 42 | import javax.inject.Inject; 43 | import javax.inject.Named; 44 | import javax.ws.rs.core.MultivaluedMap; 45 | import java.net.UnknownHostException; 46 | import java.util.Collections; 47 | import java.util.HashSet; 48 | import java.util.List; 49 | import java.util.Optional; 50 | import java.util.Set; 51 | import java.util.stream.Collectors; 52 | 53 | public class SsoAuthRealm extends AuthenticatingRealm { 54 | private static final Logger LOG = LoggerFactory.getLogger(SsoAuthRealm.class); 55 | 56 | public static final String NAME = "sso"; 57 | 58 | private final LdapUserAuthenticator ldapAuthenticator; 59 | 60 | private final UserService userService; 61 | private final ClusterConfigService clusterConfigService; 62 | private final RoleService roleService; 63 | private final Set trustedProxies; 64 | 65 | @Inject 66 | public SsoAuthRealm(UserService userService, 67 | ClusterConfigService clusterConfigService, 68 | RoleService roleService, 69 | LdapUserAuthenticator ldapAuthenticator, 70 | @Named("trusted_proxies") Set trustedProxies) { 71 | this.userService = userService; 72 | this.clusterConfigService = clusterConfigService; 73 | this.roleService = roleService; 74 | this.trustedProxies = trustedProxies; 75 | this.ldapAuthenticator = ldapAuthenticator; 76 | setAuthenticationTokenClass(HttpHeadersToken.class); 77 | setCredentialsMatcher(new AllowAllCredentialsMatcher()); 78 | setCachingEnabled(false); 79 | } 80 | 81 | @Override 82 | protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException { 83 | HttpHeadersToken headersToken = (HttpHeadersToken) token; 84 | final MultivaluedMap requestHeaders = headersToken.getHeaders(); 85 | 86 | final SsoAuthConfig config = clusterConfigService.getOrDefault( 87 | SsoAuthConfig.class, 88 | SsoAuthConfig.defaultConfig("")); 89 | 90 | final String usernameHeader = config.usernameHeader(); 91 | 92 | final Optional userNameOption = headerValue(requestHeaders, usernameHeader); 93 | if (userNameOption.isPresent()) { 94 | if (config.requireTrustedProxies()) { 95 | if (inTrustedSubnets(headersToken.getRemoteAddr())) { 96 | LOG.info("Request with trusted header {} received from {} which is not in the trusted subnets: {}", 97 | usernameHeader, 98 | headersToken.getRemoteAddr(), 99 | Joiner.on(", ").join(trustedProxies)); 100 | return null; 101 | } 102 | } 103 | final String username = userNameOption.get(); 104 | User user = null; 105 | 106 | if (ldapAuthenticator.isEnabled()) { 107 | user = ldapAuthenticator.syncLdapUser(username); 108 | } 109 | 110 | if (user == null) { 111 | user = userService.load(username); 112 | } 113 | 114 | if (user == null) { 115 | if (config.autoCreateUser()) { 116 | user = userService.create(); 117 | 118 | // common fields 119 | user.setName(username); 120 | user.setExternal(true); 121 | user.setPassword("dummy password"); 122 | user.setPermissions(Collections.emptyList()); 123 | 124 | // fields based on optional headers 125 | final Optional fullnameHeaderOption = headerValue(requestHeaders, config.fullnameHeader()); 126 | user.setFullName(fullnameHeaderOption.orElse(username)); 127 | 128 | final Optional emailHeaderOption = headerValue(requestHeaders, config.emailHeader()); 129 | if (emailHeaderOption.isPresent()) { 130 | user.setEmail(emailHeaderOption.get()); 131 | } else { 132 | user.setEmail(username + "@" + Optional.ofNullable(config.defaultEmailDomain()).orElse("localhost")); 133 | } 134 | 135 | final String defaultGroup = config.defaultGroup(); 136 | if (defaultGroup != null) { 137 | try { 138 | Role role = roleService.loadAllLowercaseNameMap().get(defaultGroup.toLowerCase()); 139 | if (role != null) { 140 | user.setRoleIds(Collections.singleton(role.getId())); 141 | } else { 142 | LOG.warn("Could not find group named {}, giving user reader role instead", defaultGroup); 143 | user.setRoleIds(Collections.singleton(roleService.getReaderRoleObjectId())); 144 | } 145 | } 146 | catch (NotFoundException e) { 147 | LOG.info("Unable to retrieve roles, giving user reader role"); 148 | user.setRoleIds(Collections.singleton(roleService.getReaderRoleObjectId())); 149 | } 150 | } else { 151 | user.setRoleIds(Collections.singleton(roleService.getReaderRoleObjectId())); 152 | } 153 | try { 154 | userService.save(user); 155 | } catch (ValidationException e) { 156 | LOG.error("Unable to save auto created user {}. Not logging in with http header.", user, e); 157 | return null; 158 | } 159 | } else { 160 | LOG.trace( 161 | "No user named {} found and automatic user creation is disabled, not using content of trusted header {}", 162 | username, 163 | usernameHeader); 164 | return null; 165 | } 166 | } 167 | LOG.trace("Trusted header {} set, continuing with user name {}", usernameHeader, user.getName()); 168 | 169 | if (config.syncRoles()) { 170 | Optional> rolesList = headerValues(requestHeaders, config.rolesHeader()); 171 | if (rolesList.isPresent()) { 172 | try { 173 | syncUserRoles(rolesList.get(), user); 174 | } catch (ValidationException e) { 175 | LOG.error( 176 | "Unable to sync roles [{}] of user {} from http header. Not logging in with http header.", 177 | rolesList.get(), user, e); 178 | return null; 179 | } 180 | } 181 | } 182 | 183 | ShiroSecurityContext.requestSessionCreation(true); 184 | return new SimpleAccount(user.getName(), null, NAME); 185 | } 186 | LOG.debug("Trusted header {} is not set.", usernameHeader); 187 | return null; 188 | } 189 | 190 | protected Set csv(List values) { 191 | Set uniqValues = new HashSet<>(); 192 | for (String csString : values) { 193 | String[] valueArr = csString.split(","); 194 | 195 | for (String value : valueArr) { 196 | uniqValues.add(value.trim()); 197 | } 198 | } 199 | return uniqValues; 200 | } 201 | 202 | protected void syncUserRoles(List roleCsv, User user) throws ValidationException { 203 | Set roleNames = csv(roleCsv); 204 | Set existingRoles = user.getRoleIds(); 205 | 206 | Set syncedRoles = new HashSet<>(); 207 | for (String roleName : roleNames) { 208 | if (roleService.exists(roleName)) { 209 | try { 210 | Role r = roleService.load(roleName); 211 | syncedRoles.add(r.getId()); 212 | } catch (NotFoundException e) { 213 | LOG.error("Role {} not found, but it existed before", roleName); 214 | } 215 | } 216 | } 217 | if (existingRoles != null && !existingRoles.equals(syncedRoles)) { 218 | user.setRoleIds(syncedRoles); 219 | userService.save(user); 220 | } 221 | } 222 | 223 | @VisibleForTesting 224 | @SuppressWarnings("WeakerAccess") 225 | boolean inTrustedSubnets(String remoteAddr) { 226 | return !trustedProxies.stream() 227 | .anyMatch(ipSubnet -> { 228 | try { 229 | return ipSubnet.contains(remoteAddr); 230 | } catch (UnknownHostException ignored) { 231 | LOG.debug("Looking up remote address {} failed.", remoteAddr); 232 | return false; 233 | } 234 | }); 235 | } 236 | 237 | private Optional headerValue(MultivaluedMap headers, @Nullable String headerName) { 238 | if (headerName == null) { 239 | return Optional.empty(); 240 | } 241 | return Optional.ofNullable(headers.getFirst(headerName.toLowerCase())); 242 | } 243 | 244 | protected Optional> headerValues(MultivaluedMap headers, 245 | @Nullable String headerNamePrefix) { 246 | if (headerNamePrefix == null) { 247 | return Optional.empty(); 248 | } 249 | Set keys = headers.keySet(); 250 | List headerValues = keys.stream().filter(key -> key.startsWith(headerNamePrefix.toLowerCase())) 251 | .map(key -> headers.getFirst(key)).collect(Collectors.toList()); 252 | 253 | return Optional.ofNullable(headerValues); 254 | } 255 | } 256 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/auth/sso/SsoConfigResource.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Archive. 3 | * 4 | * Graylog Archive is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Archive is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Archive. If not, see . 16 | */ 17 | package org.graylog.plugins.auth.sso; 18 | 19 | import com.google.common.base.Joiner; 20 | import io.swagger.annotations.Api; 21 | import io.swagger.annotations.ApiOperation; 22 | import io.swagger.annotations.ApiParam; 23 | import org.apache.shiro.authz.annotation.RequiresAuthentication; 24 | import org.apache.shiro.authz.annotation.RequiresPermissions; 25 | import org.graylog.plugins.auth.sso.audit.SsoAuthAuditEventTypes; 26 | import org.graylog2.audit.jersey.AuditEvent; 27 | import org.graylog2.plugin.cluster.ClusterConfigService; 28 | import org.graylog2.plugin.rest.PluginRestResource; 29 | import org.graylog2.shared.rest.resources.RestResource; 30 | import org.graylog2.utilities.IpSubnet; 31 | 32 | import javax.inject.Inject; 33 | import javax.inject.Named; 34 | import javax.validation.constraints.NotNull; 35 | import javax.ws.rs.Consumes; 36 | import javax.ws.rs.GET; 37 | import javax.ws.rs.PUT; 38 | import javax.ws.rs.Path; 39 | import javax.ws.rs.Produces; 40 | import javax.ws.rs.core.MediaType; 41 | import java.util.Set; 42 | 43 | @Api(value = "SSO/Config", description = "Manage SSO authenticator configuration") 44 | @Path("/config") 45 | @Produces(MediaType.APPLICATION_JSON) 46 | @RequiresAuthentication 47 | public class SsoConfigResource extends RestResource implements PluginRestResource { 48 | 49 | private final ClusterConfigService clusterConfigService; 50 | private final String trustedProxies; 51 | 52 | @Inject 53 | private SsoConfigResource(ClusterConfigService clusterConfigService, 54 | @Named("trusted_proxies") Set trustedProxies) { 55 | this.clusterConfigService = clusterConfigService; 56 | this.trustedProxies = Joiner.on(", ").join(trustedProxies); 57 | } 58 | 59 | @ApiOperation(value = "Get SSO configuration") 60 | @GET 61 | @RequiresPermissions(SsoAuthPermissions.CONFIG_READ) 62 | public SsoAuthConfig get() { 63 | final SsoAuthConfig config = clusterConfigService.getOrDefault(SsoAuthConfig.class, 64 | SsoAuthConfig.defaultConfig(trustedProxies)); 65 | return config.toBuilder().trustedProxies(trustedProxies).build(); 66 | } 67 | 68 | @ApiOperation(value = "Update SSO configuration") 69 | @Consumes(MediaType.APPLICATION_JSON) 70 | @PUT 71 | @RequiresPermissions(SsoAuthPermissions.CONFIG_UPDATE) 72 | @AuditEvent(type = SsoAuthAuditEventTypes.CONFIG_UPDATE) 73 | public SsoAuthConfig update(@ApiParam(name = "config", required = true) @NotNull SsoAuthConfig config) { 74 | // we do not want to store trustedProxies in the cluster config because it is not editable in the UI 75 | final SsoAuthConfig cleanConfig = config.toBuilder().trustedProxies(null).build(); 76 | clusterConfigService.write(cleanConfig); 77 | // return the original one because the UI needs to see the trustedProxies again. Well, this time I _am_ sorry. 78 | return config; 79 | } 80 | 81 | } 82 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/auth/sso/audit/SsoAuthAuditEventTypes.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Archive. 3 | * 4 | * Graylog Archive is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Archive is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Archive. If not, see . 16 | */ 17 | package org.graylog.plugins.auth.sso.audit; 18 | 19 | import com.google.common.collect.ImmutableSet; 20 | import org.graylog2.audit.PluginAuditEventTypes; 21 | 22 | import java.util.Set; 23 | 24 | public class SsoAuthAuditEventTypes implements PluginAuditEventTypes { 25 | private static final String NAMESPACE = "sso_auth:"; 26 | 27 | public static final String CONFIG_UPDATE = NAMESPACE + "config:update"; 28 | 29 | private static final Set EVENT_TYPES = ImmutableSet.builder() 30 | .add(CONFIG_UPDATE) 31 | .build(); 32 | 33 | @Override 34 | public Set auditEventTypes() { 35 | return EVENT_TYPES; 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/services/org.graylog2.plugin.Plugin: -------------------------------------------------------------------------------- 1 | org.graylog.plugins.auth.sso.SsoAuthPlugin -------------------------------------------------------------------------------- /src/main/resources/org.graylog.plugins.graylog-plugin-auth-sso/graylog-plugin.properties: -------------------------------------------------------------------------------- 1 | # The plugin version 2 | version=${project.version} 3 | 4 | # The required Graylog server version 5 | graylog.version=${graylog.version} 6 | 7 | # When set to true (the default) the plugin gets a separate class loader 8 | # when loading the plugin. When set to false, the plugin shares a class loader 9 | # with other plugins that have isolated=false. 10 | # 11 | # Do not disable this unless this plugin depends on another plugin! 12 | isolated=true 13 | -------------------------------------------------------------------------------- /src/test/java/org/graylog/plugins/auth/sso/SsoAuthRealmTest.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Archive. 3 | * 4 | * Graylog Archive is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Archive is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Archive. If not, see . 16 | */ 17 | package org.graylog.plugins.auth.sso; 18 | 19 | import com.google.common.collect.Maps; 20 | import org.apache.shiro.authc.AuthenticationInfo; 21 | import org.glassfish.jersey.internal.util.collection.MultivaluedStringMap; 22 | import org.graylog2.plugin.cluster.ClusterConfigService; 23 | import org.graylog2.plugin.database.users.User; 24 | import org.graylog2.security.PasswordAlgorithmFactory; 25 | import org.graylog2.security.hashing.SHA1HashPasswordAlgorithm; 26 | import org.graylog2.security.realm.LdapUserAuthenticator; 27 | import org.graylog2.shared.security.HttpHeadersToken; 28 | import org.graylog2.shared.security.Permissions; 29 | import org.graylog2.shared.users.UserService; 30 | import org.graylog2.users.RoleImpl; 31 | import org.graylog2.users.RoleService; 32 | import org.graylog2.users.UserImpl; 33 | import org.graylog2.utilities.IpSubnet; 34 | import org.junit.Test; 35 | import org.mockito.Mockito; 36 | 37 | import java.net.UnknownHostException; 38 | import java.util.Arrays; 39 | import java.util.Collections; 40 | import java.util.HashSet; 41 | import java.util.List; 42 | import java.util.Optional; 43 | import java.util.Set; 44 | 45 | import javax.ws.rs.core.MultivaluedHashMap; 46 | 47 | import static org.assertj.core.api.Assertions.assertThat; 48 | import static org.junit.Assert.assertEquals; 49 | import static org.junit.Assert.fail; 50 | import static org.mockito.ArgumentMatchers.any; 51 | import static org.mockito.ArgumentMatchers.anyString; 52 | import static org.mockito.ArgumentMatchers.eq; 53 | import static org.mockito.Mockito.mock; 54 | import static org.mockito.Mockito.never; 55 | import static org.mockito.Mockito.spy; 56 | import static org.mockito.Mockito.verify; 57 | import static org.mockito.Mockito.when; 58 | 59 | public class SsoAuthRealmTest { 60 | 61 | @Test 62 | public void checkSubnetConfig() throws UnknownHostException { 63 | Set trustedProxies = Collections.singleton(new IpSubnet("192.168.0.0/24")); 64 | final ClusterConfigService configService = mock(ClusterConfigService.class); 65 | 66 | when(configService.getOrDefault(any(), any())) 67 | .thenReturn(SsoAuthConfig.builder() 68 | .usernameHeader("X-Remote-User") 69 | .autoCreateUser(false) 70 | .emailHeader("") 71 | .fullnameHeader("") 72 | .requireTrustedProxies(false) 73 | .syncRoles(false) 74 | .rolesHeader("Roles") 75 | .build()); 76 | 77 | final UserService userService = mock(UserService.class); 78 | when(userService.load(eq("horst"))).thenReturn(new UserImpl(mock(PasswordAlgorithmFactory.class), 79 | mock(Permissions.class), 80 | Maps.newHashMap())); 81 | final SsoAuthRealm realm = new SsoAuthRealm(userService, 82 | configService, 83 | mock(RoleService.class), 84 | mock(LdapUserAuthenticator.class), 85 | trustedProxies); 86 | 87 | final MultivaluedStringMap headers = new MultivaluedStringMap(); 88 | // headers must be lowercase, jersey does this the same way 89 | headers.put("x-remote-user", Collections.singletonList("horst")); 90 | final HttpHeadersToken headersToken = new HttpHeadersToken(headers, "192.168.0.1", "192.168.0.1"); 91 | final SsoAuthRealm realmSpy = spy(realm); 92 | final AuthenticationInfo info = realmSpy.doGetAuthenticationInfo(headersToken); 93 | 94 | assertThat(info).isNotNull(); 95 | assertThat(info.getPrincipals().getPrimaryPrincipal()).isNotNull(); 96 | 97 | verify(userService).load(eq("horst")); 98 | verify(realmSpy, never()).inTrustedSubnets(anyString()); 99 | } 100 | 101 | @Test 102 | public void testDefaultDomain() { 103 | 104 | final ClusterConfigService configService = mock(ClusterConfigService.class); 105 | 106 | when(configService.getOrDefault(any(), any())) 107 | .thenReturn(SsoAuthConfig.builder() 108 | .usernameHeader("X-Remote-User") 109 | .autoCreateUser(true) 110 | .emailHeader(null) 111 | .fullnameHeader(null) 112 | .requireTrustedProxies(false) 113 | .defaultEmailDomain("domain.de") 114 | .syncRoles(false) 115 | .rolesHeader("Roles") 116 | .build()); 117 | 118 | final UserService userService = mock(UserService.class); 119 | final UserImpl user = new UserImpl( 120 | new PasswordAlgorithmFactory(Collections.emptyMap(), 121 | new SHA1HashPasswordAlgorithm("1234567890")), 122 | mock(Permissions.class), 123 | Maps.newHashMap()); 124 | when(userService.create()).thenReturn(user); 125 | 126 | final RoleService roleService = mock(RoleService.class); 127 | when(roleService.getReaderRoleObjectId()).thenReturn("57a1d276227c473674e1d997"); 128 | final SsoAuthRealm realm = new SsoAuthRealm(userService, 129 | configService, 130 | roleService, 131 | mock(LdapUserAuthenticator.class), 132 | Collections.emptySet()); 133 | 134 | final MultivaluedStringMap headers = new MultivaluedStringMap(); 135 | // headers must be lowercase, jersey does this the same way 136 | headers.put("x-remote-user", Collections.singletonList("horst")); 137 | final HttpHeadersToken headersToken = new HttpHeadersToken(headers, "192.168.0.1", "192.168.0.1"); 138 | final SsoAuthRealm realmSpy = spy(realm); 139 | final AuthenticationInfo info = realmSpy.doGetAuthenticationInfo(headersToken); 140 | 141 | assertThat(info).isNotNull(); 142 | verify(userService).create(); 143 | assertThat(user.getEmail()).isEqualTo("horst@domain.de"); 144 | } 145 | 146 | @Test 147 | public void testDefaultDomainNotSet() { 148 | 149 | final ClusterConfigService configService = mock(ClusterConfigService.class); 150 | 151 | when(configService.getOrDefault(any(), any())) 152 | .thenReturn(SsoAuthConfig.builder() 153 | .usernameHeader("X-Remote-User") 154 | .autoCreateUser(true) 155 | .emailHeader(null) 156 | .fullnameHeader(null) 157 | .requireTrustedProxies(false) 158 | .syncRoles(false) 159 | .rolesHeader("Roles") 160 | .build()); 161 | 162 | final UserService userService = mock(UserService.class); 163 | final UserImpl user = new UserImpl( 164 | new PasswordAlgorithmFactory(Collections.emptyMap(), 165 | new SHA1HashPasswordAlgorithm("1234567890")), 166 | mock(Permissions.class), 167 | Maps.newHashMap()); 168 | when(userService.create()).thenReturn(user); 169 | 170 | final RoleService roleService = mock(RoleService.class); 171 | when(roleService.getReaderRoleObjectId()).thenReturn("57a1d276227c473674e1d997"); 172 | final SsoAuthRealm realm = new SsoAuthRealm(userService, 173 | configService, 174 | roleService, 175 | mock(LdapUserAuthenticator.class), 176 | Collections.emptySet()); 177 | 178 | final MultivaluedStringMap headers = new MultivaluedStringMap(); 179 | // headers must be lowercase, jersey does this the same way 180 | headers.put("x-remote-user", Collections.singletonList("horst")); 181 | final HttpHeadersToken headersToken = new HttpHeadersToken(headers, "192.168.0.1", "192.168.0.1"); 182 | final SsoAuthRealm realmSpy = spy(realm); 183 | final AuthenticationInfo info = realmSpy.doGetAuthenticationInfo(headersToken); 184 | 185 | assertThat(info).isNotNull(); 186 | verify(userService).create(); 187 | assertThat(user.getEmail()).isEqualTo("horst@localhost"); 188 | } 189 | 190 | @Test 191 | public void testHeaderValuesCsv() { 192 | MultivaluedHashMap m = new MultivaluedHashMap<>(); 193 | m.put("roles", Arrays.asList(new String[]{"role1, role2, role3"})); 194 | m.put("roles_1", Arrays.asList(new String[]{"asdf1"})); 195 | m.put("roles_2", Arrays.asList(new String[]{"asdf2"})); 196 | 197 | SsoAuthRealm r = new SsoAuthRealm(null, null, null, null, Collections.emptySet()); 198 | Optional> s = r.headerValues(m, "Roles"); 199 | Set actual = r.csv(s.get()); 200 | List expected = Arrays.asList(new String[]{"role1","role2","role3","asdf1","asdf2"}); 201 | 202 | assertEquals(actual.size(), expected.size()); 203 | for ( String role : expected) { 204 | if ( !actual.contains(role)) { 205 | fail("Role [" + role + "] expected, but not in result: " + actual); 206 | } 207 | } 208 | 209 | } 210 | 211 | @Test 212 | public void testSyncRoles() throws Exception { 213 | List rolesCsv = Arrays.asList(new String[]{"role1","role2", "role3, role4"}); 214 | 215 | User u = Mockito.spy(User.class); 216 | Set existingRoles = new HashSet<>(); 217 | 218 | when(u.getRoleIds()).thenReturn(existingRoles); 219 | 220 | RoleService roleService = mock(RoleService.class); 221 | UserService userService = mock(UserService.class); 222 | 223 | 224 | when(roleService.exists(anyString())).thenReturn(true); 225 | RoleImpl role1 = new RoleImpl(); 226 | role1._id = "1"; 227 | role1.name = "role1"; 228 | 229 | when(roleService.load("role1")).thenReturn(role1); 230 | 231 | RoleImpl role2 = new RoleImpl(); 232 | role2._id = "2"; 233 | role2.name = "role2"; 234 | 235 | when(roleService.load("role2")).thenReturn(role2); 236 | 237 | RoleImpl role3 = new RoleImpl(); 238 | role3._id = "3"; 239 | role3.name = "role3"; 240 | 241 | when(roleService.load("role3")).thenReturn(role3); 242 | RoleImpl role4 = new RoleImpl(); 243 | role4._id = "4"; 244 | role4.name = "role4"; 245 | 246 | when(roleService.load("role4")).thenReturn(role4); 247 | 248 | Set syncRoles = new HashSet<>(); 249 | syncRoles.add(role1._id); 250 | syncRoles.add(role2._id); 251 | syncRoles.add(role3._id); 252 | syncRoles.add(role4._id); 253 | 254 | Mockito.doNothing().when(u).setRoleIds(syncRoles); 255 | 256 | when(userService.save(u)).thenReturn("user"); 257 | 258 | SsoAuthRealm r = new SsoAuthRealm(userService, null, roleService, null, Collections.emptySet()); 259 | r.syncUserRoles(rolesCsv, u); 260 | 261 | verify(u).getRoleIds(); 262 | verify(u).setRoleIds(syncRoles); 263 | verify(userService).save(u); 264 | } 265 | } -------------------------------------------------------------------------------- /src/web/SsoAuthActions.jsx: -------------------------------------------------------------------------------- 1 | import Reflux from 'reflux'; 2 | 3 | const SsoAuthActions = Reflux.createActions({ 4 | config: { asyncResult: true }, 5 | saveConfig: { asyncResult: true }, 6 | }); 7 | 8 | export default SsoAuthActions; 9 | -------------------------------------------------------------------------------- /src/web/SsoAuthStore.jsx: -------------------------------------------------------------------------------- 1 | import Reflux from 'reflux'; 2 | 3 | import SsoAuthActions from 'SsoAuthActions'; 4 | 5 | import UserNotification from 'util/UserNotification'; 6 | import URLUtils from 'util/URLUtils'; 7 | import fetch from 'logic/rest/FetchProvider'; 8 | 9 | const urlPrefix = '/plugins/org.graylog.plugins.auth.sso'; 10 | 11 | const SsoAuthStore = Reflux.createStore({ 12 | listenables: [SsoAuthActions], 13 | 14 | getInitialState() { 15 | return { 16 | config: undefined, 17 | }; 18 | }, 19 | 20 | _errorHandler(message, title, cb) { 21 | return (error) => { 22 | let errorMessage; 23 | try { 24 | errorMessage = error.additional.body.message; 25 | } catch (e) { 26 | errorMessage = error.message; 27 | } 28 | UserNotification.error(`${message}: ${errorMessage}`, title); 29 | if (cb) { 30 | cb(error); 31 | } 32 | }; 33 | }, 34 | 35 | _url(path) { 36 | return URLUtils.qualifyUrl(`${urlPrefix}${path}`); 37 | }, 38 | 39 | config() { 40 | const promise = fetch('GET', this._url('/config')); 41 | 42 | promise.then((response) => { 43 | this.trigger({ config: response }); 44 | }, this._errorHandler('Fetching config failed', 'Could not retrieve SSO authenticator config')); 45 | 46 | SsoAuthActions.config.promise(promise); 47 | }, 48 | 49 | saveConfig(config) { 50 | const promise = fetch('PUT', this._url('/config'), config); 51 | 52 | promise.then((response) => { 53 | this.trigger({ config: response }); 54 | UserNotification.success('SSO configuration was updated successfully'); 55 | }, this._errorHandler('Updating SSO config failed', 'Unable to update SSO authenticator config')); 56 | 57 | SsoAuthActions.saveConfig.promise(promise); 58 | }, 59 | }); 60 | 61 | export default SsoAuthStore; -------------------------------------------------------------------------------- /src/web/SsoConfiguration.jsx: -------------------------------------------------------------------------------- 1 | import React from "react"; 2 | import Reflux from "reflux"; 3 | 4 | import { Row, Col, Button, Alert } from "components/graylog"; 5 | import { Input } from 'components/bootstrap'; 6 | 7 | import { PageHeader, Spinner } from "components/common"; 8 | import SsoAuthActions from "SsoAuthActions"; 9 | import SsoAuthStore from "SsoAuthStore"; 10 | 11 | import StoreProvider from 'injection/StoreProvider'; 12 | const RolesStore = StoreProvider.getStore('Roles') 13 | 14 | import ObjectUtils from 'util/ObjectUtils'; 15 | 16 | class SsoConfiguration extends React.Component { 17 | state = {}; 18 | 19 | componentDidMount() { 20 | SsoAuthActions.config().then(config => this.setState({ config })); 21 | RolesStore.loadRoles().done(roles => { 22 | this.setState({ roles: roles.map(role => role.name) }); 23 | }); 24 | } 25 | 26 | _saveSettings = (ev) => { 27 | ev.preventDefault(); 28 | SsoAuthActions.saveConfig(this.state.config); 29 | }; 30 | 31 | _setSetting = (attribute, value) => { 32 | const newState = {}; 33 | 34 | // Clone state to not modify it directly 35 | const settings = ObjectUtils.clone(this.state.config); 36 | settings[attribute] = value; 37 | newState.config = settings; 38 | this.setState(newState); 39 | }; 40 | 41 | _bindChecked = (ev, value) => { 42 | this._setSetting(ev.target.name, typeof value === 'undefined' ? ev.target.checked : value); 43 | }; 44 | 45 | _bindValue = (ev) => { 46 | this._setSetting(ev.target.name, ev.target.value); 47 | }; 48 | 49 | render() { 50 | let content; 51 | if (!this.state.config || !this.state.roles) { 52 | content = ; 53 | } else { 54 | let trustedProxies = null; 55 | if (this.state.config.trusted_proxies) { 56 | trustedProxies = 57 | The current subnet setting is: {this.state.config.trusted_proxies}. You can configure the setting in the Graylog server configuration file. 58 | ; 59 | } else { 60 | trustedProxies = 61 |

There are no trusted proxies set!

62 | Please configure the trusted_proxies setting in the Graylog server configuration file. 63 | ; 64 | } 65 | const subnetHelp = ( 66 | Enable this to require the request containing the SSO header as directly coming from a trusted proxy. This is highly recommended to avoid header injection. 67 |
68 | {trustedProxies} 69 | ); 70 | const roles = this.state.roles.map((role) => ); 71 | content = ( 72 | 73 | 74 |
75 |
76 | Header configuration 77 | 81 |
82 |
83 | Security 84 | 91 |
92 |
93 | User creation 94 | 101 | 105 | 109 | 113 | 116 | 117 | 118 | 123 | 124 | 125 | 126 |
127 |
128 | Role synchronization 129 | 136 | 140 |
141 |
142 | Store settings 143 |
144 | 145 | 146 | 147 |
148 |
149 |
150 | 151 | 152 | ); 153 | } 154 | 155 | return ( 156 |
157 | 158 | Configuration page for the SSO authenticator. 159 | {null} 160 | 161 | {content} 162 |
163 | ); 164 | } 165 | } 166 | 167 | export default SsoConfiguration; 168 | -------------------------------------------------------------------------------- /src/web/index.jsx: -------------------------------------------------------------------------------- 1 | // eslint-disable-next-line no-unused-vars 2 | import webpackEntry from 'webpack-entry'; 3 | 4 | import packageJson from '../../package.json'; 5 | import { PluginManifest, PluginStore } from 'graylog-web-plugin/plugin'; 6 | import SsoConfiguration from "./SsoConfiguration"; 7 | 8 | PluginStore.register(new PluginManifest(packageJson, { 9 | authenticatorConfigurations: [ 10 | { 11 | name: 'sso', 12 | displayName: 'Single Sign-On (SSO)', 13 | description: 'Creates and authenticates users based on HTTP headers set by an authentication proxy to integrate with SSO systems', 14 | canBeDisabled: true, 15 | component: SsoConfiguration, 16 | }, 17 | ] 18 | })); 19 | -------------------------------------------------------------------------------- /webpack.config.js: -------------------------------------------------------------------------------- 1 | const PluginWebpackConfig = require('graylog-web-plugin').PluginWebpackConfig; 2 | const loadBuildConfig = require('graylog-web-plugin').loadBuildConfig; 3 | const path = require('path'); 4 | 5 | // Remember to use the same name here and in `getUniqueId()` in the java MetaData class 6 | module.exports = new PluginWebpackConfig('org.graylog.plugins.auth.sso.SsoAuthPlugin', loadBuildConfig(path.resolve(__dirname, './build.config')), { 7 | // Here goes your additional webpack configuration. 8 | }); 9 | --------------------------------------------------------------------------------