edu.vt.middleware.ldap.auth.AuthenticatorCli Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vt-ldap Show documentation
Library for performing common LDAP operations
There is a newer version: 3.3.9
/*
  $Id: AuthenticatorCli.java 1330 2010-05-23 22:10:53Z dfisher $

  Copyright (C) 2003-2010 Virginia Tech.
  All rights reserved.

  SEE LICENSE FOR MORE INFORMATION

  Author:  Middleware Services
  Email:   [email protected]
  Version: $Revision: 1330 $
  Updated: $Date: 2010-05-23 18:10:53 -0400 (Sun, 23 May 2010) $
*/
package edu.vt.middleware.ldap.auth;

import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
import javax.naming.directory.Attributes;
import edu.vt.middleware.ldap.AbstractCli;
import edu.vt.middleware.ldap.bean.LdapAttributes;
import edu.vt.middleware.ldap.bean.LdapBeanProvider;
import edu.vt.middleware.ldap.bean.LdapEntry;
import edu.vt.middleware.ldap.bean.LdapResult;
import edu.vt.middleware.ldap.dsml.Dsmlv1;
import edu.vt.middleware.ldap.dsml.Dsmlv2;
import edu.vt.middleware.ldap.ldif.Ldif;
import edu.vt.middleware.ldap.props.LdapConfigPropertyInvoker;
import org.apache.commons.cli.CommandLine;

/**
 * Command line interface for authenticator operations.
 *
 * @author  Middleware Services
 * @version  $Revision: 1330 $
 */
public class AuthenticatorCli extends AbstractCli
{

  /** Name of operation provided by this class. */
  private static final String COMMAND_NAME = "ldapauth";


  /**
   * CLI entry point method.
   *
   * @param  args  Command line arguments.
   */
  public static void main(final String[] args)
  {
    new AuthenticatorCli().performAction(args);
  }


  /** {@inheritDoc} */
  protected void initOptions()
  {
    super.initOptions(
      new LdapConfigPropertyInvoker(
        AuthenticatorConfig.class,
        AuthenticatorConfig.PROPERTIES_DOMAIN));
  }


  /**
   * Initialize an AuthenticatorConfig with command line options.
   *
   * @param  line  Parsed command line arguments container.
   *
   * @return  AuthenticatorConfig that has been initialized
   *
   * @throws  Exception  On errors thrown by handler.
   */
  protected AuthenticatorConfig initAuthenticatorConfig(final CommandLine line)
    throws Exception
  {
    final AuthenticatorConfig config = new AuthenticatorConfig();
    this.initLdapProperties(config, line);
    if (line.hasOption(OPT_TRACE)) {
      config.setTracePackets(System.out);
    }
    if (config.getBindDn() != null && config.getBindCredential() == null) {
      // prompt the user to enter a password
      System.out.print(
        "Enter password for service user " + config.getBindDn() + ": ");

      final String pass = (new BufferedReader(new InputStreamReader(System.in)))
          .readLine();
      config.setBindCredential(pass);
    }
    if (config.getUser() == null) {
      // prompt for a user name
      System.out.print("Enter user name: ");

      final String user = (new BufferedReader(new InputStreamReader(System.in)))
          .readLine();
      config.setUser(user);
    }
    if (config.getCredential() == null) {
      // prompt the user to enter a password
      System.out.print("Enter password for user " + config.getUser() + ": ");

      final String pass = (new BufferedReader(new InputStreamReader(System.in)))
          .readLine();
      config.setCredential(pass);
    }
    return config;
  }


  /** {@inheritDoc} */
  protected void dispatch(final CommandLine line)
    throws Exception
  {
    if (line.hasOption(OPT_DSMLV1)) {
      this.outputDsmlv1 = true;
    } else if (line.hasOption(OPT_DSMLV2)) {
      this.outputDsmlv2 = true;
    }
    if (line.hasOption(OPT_HELP)) {
      printHelp();
    } else {
      authenticate(initAuthenticatorConfig(line), line.getArgs());
    }
  }


  /**
   * Executes the authenticate operation.
   *
   * @param  config  Authenticator configuration.
   * @param  attrs  Ldap attributes to return
   *
   * @throws  Exception  On errors.
   */
  protected void authenticate(
    final AuthenticatorConfig config,
    final String[] attrs)
    throws Exception
  {
    final Authenticator auth = new Authenticator();
    auth.setAuthenticatorConfig(config);

    Attributes results = null;
    try {
      if (attrs == null || attrs.length == 0) {
        results = auth.authenticate(null);
      } else {
        results = auth.authenticate(attrs);
      }
      if (results != null && results.size() > 0) {
        final LdapEntry entry = LdapBeanProvider.getLdapBeanFactory()
            .newLdapEntry();
        final LdapResult result = LdapBeanProvider.getLdapBeanFactory()
            .newLdapResult();
        result.addEntry(entry);
        entry.setDn(auth.getDn(config.getUser()));

        final LdapAttributes la = LdapBeanProvider.getLdapBeanFactory()
            .newLdapAttributes();
        la.addAttributes(results);
        entry.setLdapAttributes(la);
        if (this.outputDsmlv1) {
          (new Dsmlv1()).outputDsml(
            result.toSearchResults().iterator(),
            new BufferedWriter(new OutputStreamWriter(System.out)));
        } else if (this.outputDsmlv2) {
          (new Dsmlv2()).outputDsml(
            result.toSearchResults().iterator(),
            new BufferedWriter(new OutputStreamWriter(System.out)));
        } else {
          (new Ldif()).outputLdif(
            result.toSearchResults().iterator(),
            new BufferedWriter(new OutputStreamWriter(System.out)));
        }
      }
    } finally {
      if (auth != null) {
        auth.close();
      }
    }
  }


  /** {@inheritDoc} */
  protected String getCommandName()
  {
    return COMMAND_NAME;
  }
}