/**
* Waffle (https://github.com/dblock/waffle)
*
* Copyright (c) 2010 - 2014 Application Security, Inc.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Application Security, Inc.
*/
package waffle.servlet;
import java.io.Serializable;
import java.security.Principal;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import com.google.common.base.Joiner;
import waffle.windows.auth.IWindowsAccount;
import waffle.windows.auth.IWindowsIdentity;
import waffle.windows.auth.PrincipalFormat;
import waffle.windows.auth.WindowsAccount;
/**
* A Windows Principal.
*
* @author dblock[at]dblock[dot]org
*/
public class WindowsPrincipal implements Principal, Serializable {
private static final long serialVersionUID = 1L;
private String fqn;
private byte[] sid;
private String sidString;
private List<String> roles;
private transient IWindowsIdentity identity;
private Map<String, WindowsAccount> groups;
/**
* A windows principal.
*
* @param windowsIdentity
* Windows identity.
*/
public WindowsPrincipal(final IWindowsIdentity windowsIdentity) {
this(windowsIdentity, PrincipalFormat.FQN, PrincipalFormat.FQN);
}
/**
* A windows principal.
*
* @param windowsIdentity
* Windows identity.
* @param principalFormat
* Principal format.
* @param roleFormat
* Role format.
*/
public WindowsPrincipal(final IWindowsIdentity windowsIdentity, final PrincipalFormat principalFormat,
final PrincipalFormat roleFormat) {
this.identity = windowsIdentity;
this.fqn = windowsIdentity.getFqn();
this.sid = windowsIdentity.getSid();
this.sidString = windowsIdentity.getSidString();
this.groups = getGroups(windowsIdentity.getGroups());
this.roles = getRoles(windowsIdentity, principalFormat, roleFormat);
}
private static List<String> getRoles(final IWindowsIdentity windowsIdentity, final PrincipalFormat principalFormat,
final PrincipalFormat roleFormat) {
final List<String> roles = new ArrayList<String>();
roles.addAll(getPrincipalNames(windowsIdentity, principalFormat));
for (IWindowsAccount group : windowsIdentity.getGroups()) {
roles.addAll(getRoleNames(group, roleFormat));
}
return roles;
}
private static Map<String, WindowsAccount> getGroups(final IWindowsAccount[] groups) {
final Map<String, WindowsAccount> groupMap = new HashMap<String, WindowsAccount>();
for (IWindowsAccount group : groups) {
groupMap.put(group.getFqn(), new WindowsAccount(group));
}
return groupMap;
}
/**
* Byte representation of the SID.
*
* @return Array of bytes.
*/
public byte[] getSid() {
return this.sid.clone();
}
/**
* String representation of the SID.
*
* @return String.
*/
public String getSidString() {
return this.sidString;
}
/**
* Windows groups that the user is a member of.
*
* @return A map of group names to groups.
*/
public Map<String, WindowsAccount> getGroups() {
return this.groups;
}
/**
* Returns a list of role principal objects.
*
* @param group
* Windows group.
* @param principalFormat
* Principal format.
* @return List of role principal objects.
*/
private static List<String> getRoleNames(final IWindowsAccount group, final PrincipalFormat principalFormat) {
final List<String> principals = new ArrayList<String>();
switch (principalFormat) {
case FQN:
principals.add(group.getFqn());
break;
case SID:
principals.add(group.getSidString());
break;
case BOTH:
principals.add(group.getFqn());
principals.add(group.getSidString());
break;
case NONE:
break;
default:
break;
}
return principals;
}
/**
* Returns a list of user principal objects.
*
* @param windowsIdentity
* Windows identity.
* @param principalFormat
* Principal format.
* @return A list of user principal objects.
*/
private static List<String> getPrincipalNames(final IWindowsIdentity windowsIdentity,
final PrincipalFormat principalFormat) {
final List<String> principals = new ArrayList<String>();
switch (principalFormat) {
case FQN:
principals.add(windowsIdentity.getFqn());
break;
case SID:
principals.add(windowsIdentity.getSidString());
break;
case BOTH:
principals.add(windowsIdentity.getFqn());
principals.add(windowsIdentity.getSidString());
break;
case NONE:
break;
default:
break;
}
return principals;
}
/**
* Get an array of roles as a string.
*
* @return Role1, Role2, ...
*/
public String getRolesString() {
return Joiner.on(", ").join(this.roles);
}
/**
* Checks whether the principal has a given role.
*
* @param role
* Role name.
* @return True if the principal has a role, false otherwise.
*/
public boolean hasRole(final String role) {
return this.roles.contains(role);
}
/**
* Fully qualified name.
*
* @return String.
*/
@Override
public String getName() {
return this.fqn;
}
/**
* Underlying identity.
*
* @return String.
*/
public IWindowsIdentity getIdentity() {
return this.identity;
}
@Override
public String toString() {
return this.getName();
}
}