com.netflix.spinnaker.security.User Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kork-security Show documentation
Spinnaker Kork
There is a newer version: 7.247.0
/*
 * Copyright 2015 Netflix, Inc.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package com.netflix.spinnaker.security;

import static java.util.Collections.unmodifiableCollection;
import static java.util.Collections.unmodifiableList;
import static java.util.stream.Collectors.toList;

import com.fasterxml.jackson.annotation.JsonIgnore;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.security.core.authority.SimpleGrantedAuthority;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.util.StringUtils;

/**
 * A UserDetails implementation to hook into Spring Security framework.
 *
 * User exists to propagate the allowedAccounts.
 *
 * This class is deprecated in favor of encoding allowed accounts as granted authorities, and
 * using the spring frameworks built in User object and preferring the UserDetails interface when
 * interacting.
 *
 * @deprecated use org.springframework.security.core.userdetails.User and AllowedAccountsAuthorities
 *     to encode allowed accounts callers should program against UserDetails interface use runAs on
 *     AuthenticatedRequest to switch users rather than supplying a principal directly.
 */
@Deprecated
public class User implements UserDetails {

  public static final long serialVersionUID = 7392392099262597885L;

  protected String email;
  protected String username;
  protected String firstName;
  protected String lastName;

  protected Collection roles = new ArrayList<>();
  protected Collection allowedAccounts = new ArrayList<>();

  @Override
  public List getAuthorities() {
    return roles.stream()
        .filter(StringUtils::hasText)
        .map(SimpleGrantedAuthority::new)
        .collect(toList());
  }

  /** Not used */
  @JsonIgnore
  @Override
  public String getPassword() {
    return "";
  }

  @Override
  public String getUsername() {
    return this.username == null ? this.email : this.username;
  }

  public String getEmail() {
    return email;
  }

  public void setEmail(String email) {
    this.email = email;
  }

  public void setUsername(String username) {
    this.username = username;
  }

  public String getFirstName() {
    return firstName;
  }

  public void setFirstName(String firstName) {
    this.firstName = firstName;
  }

  public String getLastName() {
    return lastName;
  }

  public void setLastName(String lastName) {
    this.lastName = lastName;
  }

  public Collection getRoles() {
    return unmodifiableCollection(roles);
  }

  public void setRoles(Collection roles) {
    this.roles = roles;
  }

  public Collection getAllowedAccounts() {
    return allowedAccounts;
  }

  public void setAllowedAccounts(Collection allowedAccounts) {
    this.allowedAccounts = allowedAccounts;
  }

  public User asImmutable() {
    return new ImmutableUser();
  }

  @Override
  public boolean isAccountNonExpired() {
    return true;
  }

  @Override
  public boolean isAccountNonLocked() {
    return true;
  }

  @Override
  public boolean isCredentialsNonExpired() {
    return true;
  }

  @Override
  public boolean isEnabled() {
    return true;
  }

  private final class ImmutableUser extends User {
    ImmutableUser() {
      this.email = User.this.email;
      this.username = User.this.username;
      this.firstName = User.this.firstName;
      this.lastName = User.this.lastName;
      this.roles = unmodifiableList(new ArrayList<>(User.this.roles));
      this.allowedAccounts = unmodifiableList(new ArrayList<>(User.this.allowedAccounts));
    }

    @Override
    public void setEmail(String email) {
      throw new UnsupportedOperationException();
    }

    @Override
    public void setUsername(String username) {
      throw new UnsupportedOperationException();
    }

    @Override
    public void setFirstName(String firstName) {
      throw new UnsupportedOperationException();
    }

    @Override
    public void setLastName(String lastName) {
      throw new UnsupportedOperationException();
    }

    @Override
    public void setRoles(Collection roles) {
      throw new UnsupportedOperationException();
    }

    @Override
    public void setAllowedAccounts(Collection allowedAccounts) {
      throw new UnsupportedOperationException();
    }

    @Override
    public User asImmutable() {
      return this;
    }
  }
}