Waffle/waffle

Enable drop-in Windows Single Sign On for popular Java web servers. https://waffle.github.io/waffle

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.Waffle:waffle:-SNAPSHOT'
	}
	dependencies {
		implementation("com.github.Waffle:waffle:-SNAPSHOT")
	}
	<dependency>
	    <groupId>com.github.Waffle</groupId>
	    <artifactId>waffle</artifactId>
	    <version>-SNAPSHOT</version>
	</dependency>

                            
    libraryDependencies += "com.github.Waffle" % "waffle" % "-SNAPSHOT"
        
        

                            
    :dependencies [[com.github.Waffle/waffle "-SNAPSHOT"]]

Readme

WAFFLE - Windows Authentication Framework

Java CI DotNET CI Coverity Scan Status Coverage Status Sonar Coverage Status Coveralls Maven central releases MIT Project Stats Github All Releases Quality Gate Status

waffle

WAFFLE is a native Windows Authentication Framework consisting of two C# and Java libraries that perform functions related to Windows authentication, supporting Negotiate, NTLM and Kerberos. Waffle also includes libraries that enable drop-in Windows Single Sign On for popular Java web servers, when running on Windows. While Waffle makes it ridiculously easy to do Windows Authentication in Java, on Windows, Waffle does not work on *nix(UNIX-like).

Unlike many other implementations Waffle on Windows does not require any server-side Kerberos keytab setup, it's a drop-in solution. You can see it in action in this slightly blurry video produced for TeamShatter.com.

Sites

Essentials

Documentation

There're several semi-independent parts to Waffle. Choose the appropriate HowTo.

  • Simple native interfaces in C# and Java to do all things Windows authentication. Useful if you're building a custom client that requires Windows authentication. See Getting Started with WAFFLE API
  • A generic Servlet Negotiate (NTLM and Kerberos) Security Filter that can be used with many web servers, including Tomcat, Jetty and WebSphere. See HowTo.
  • A Tomcat Negotiate (NTLM and Kerberos) Authenticator Valve, built for the Tomcat Web Container. See HowTo.
  • A Tomcat Single Sign-On + Form Authentication Mixed Valve, built for the Tomcat Web Container and allowing users to choose whether to do form authentication (a username and password sent to the server from a form) or Windows SSO (NTLM or Kerberos). See HowTo.
  • A Spring-Security Negotiate (NTLM and Kerberos) Filter. See HowTo.
  • A Spring-Security Windows Authentication Manager. See HowTo.
  • A JAAS Login Module, useful when extending a custom Java client that already implements JAAS to support Windows SSO. See HowTo.
  • A WildFly Security Domain implementation, offering support for local Windows and Active Directory users authentication when deploying web apps on WildFly servers. See HowTo.

Waffle was created and is sponsored by Application Security Inc.. For a long story, read the Project History. Also, feel free to use this PowerPoint presentation from NYJavaSIG to talk about Waffle.

Features

  • Account lookup locally and in Active Directory via Win32 API with zero configuration.
  • Enumerating Active Directory domains and domain information.
  • Returns computer domain / workgroup join information.
  • Supports logon for local and domain users returning consistent fully qualified names, identity (SIDs), local and domain groups, including nested.
  • Supports all functions required for implementing server-side single-signon with Negotiate and NTLM and various implementations for Java web servers.
  • Supports Windows Identity impersonation.
  • Includes a Windows Installer Merge Module for distribution of C# binaries.

How do I resolve JNA NoClassDefFound errors?

WAFFLE uses the latest version of JNA, which may conflict with other dependencies your project (or its parent) includes. If you experience issues with NoClassDefFound errors for JNA artifacts, consider one or more of the following steps to resolve the conflict:

  • Listing WAFFLE earlier (or first) in your dependency list
  • Specifying the most recent version of JNA as a dependency
  • If you are using a parent (e.g., Spring Boot) that includes JNA as a dependency, override the jna.version property

Demos

WAFFLE packages serveral demos. When building from the source, you can use mvn cargo:run to bring any of the demos up. See further README documentation in each demo (and what doesn't quite work). Additionally demos are documented in various states in documentation. This area does need some user help so feel free to contribute.

Related and Similar Products

Contributing

License and Copyright

Copyright (c) Application Security Inc., 2010-2020 and Contributors.

This project is licensed under the MIT License.

Project maintained by Daniel Doubrovkine & Jeremy Landis.