ConsoleCredentialsProvider.java

  1. /*
  2.  * Copyright (C) 2010, Google Inc.
  3.  * Copyright (C) 2008, Robin Rosenberg <robin.rosenberg@dewire.com>
  4.  * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
  5.  * and other copyright owners as documented in the project's IP log.
  6.  *
  7.  * This program and the accompanying materials are made available
  8.  * under the terms of the Eclipse Distribution License v1.0 which
  9.  * accompanies this distribution, is reproduced below, and is
  10.  * available at http://www.eclipse.org/org/documents/edl-v10.php
  11.  *
  12.  * All rights reserved.
  13.  *
  14.  * Redistribution and use in source and binary forms, with or
  15.  * without modification, are permitted provided that the following
  16.  * conditions are met:
  17.  *
  18.  * - Redistributions of source code must retain the above copyright
  19.  *   notice, this list of conditions and the following disclaimer.
  20.  *
  21.  * - Redistributions in binary form must reproduce the above
  22.  *   copyright notice, this list of conditions and the following
  23.  *   disclaimer in the documentation and/or other materials provided
  24.  *   with the distribution.
  25.  *
  26.  * - Neither the name of the Eclipse Foundation, Inc. nor the
  27.  *   names of its contributors may be used to endorse or promote
  28.  *   products derived from this software without specific prior
  29.  *   written permission.
  30.  *
  31.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  32.  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  33.  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  34.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  35.  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  36.  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  37.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  38.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  39.  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  40.  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  41.  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  42.  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  43.  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  44.  */

  45. package org.eclipse.jgit.console;

  46. import java.io.Console;

  47. import org.eclipse.jgit.errors.UnsupportedCredentialItem;
  48. import org.eclipse.jgit.pgm.internal.CLIText;
  49. import org.eclipse.jgit.transport.ChainingCredentialsProvider;
  50. import org.eclipse.jgit.transport.CredentialItem;
  51. import org.eclipse.jgit.transport.CredentialsProvider;
  52. import org.eclipse.jgit.transport.NetRCCredentialsProvider;
  53. import org.eclipse.jgit.transport.URIish;

  54. /**
  55.  * Interacts with the user during authentication by using the text console.
  56.  *
  57.  * @since 4.0
  58.  */
  59. public class ConsoleCredentialsProvider extends CredentialsProvider {
  60.     /**
  61.      * Install this implementation as the default.
  62.      */
  63.     public static void install() {
  64.         final ConsoleCredentialsProvider c = new ConsoleCredentialsProvider();
  65.         if (c.cons == null)
  66.             throw new NoClassDefFoundError(
  67.                     CLIText.get().noSystemConsoleAvailable);
  68.         CredentialsProvider cp = new ChainingCredentialsProvider(
  69.                 new NetRCCredentialsProvider(), c);
  70.         CredentialsProvider.setDefault(cp);
  71.     }

  72.     private final Console cons = System.console();

  73.     /** {@inheritDoc} */
  74.     @Override
  75.     public boolean isInteractive() {
  76.         return true;
  77.     }

  78.     /** {@inheritDoc} */
  79.     @Override
  80.     public boolean supports(CredentialItem... items) {
  81.         for (CredentialItem i : items) {
  82.             if (i instanceof CredentialItem.StringType)
  83.                 continue;

  84.             else if (i instanceof CredentialItem.CharArrayType)
  85.                 continue;

  86.             else if (i instanceof CredentialItem.YesNoType)
  87.                 continue;

  88.             else if (i instanceof CredentialItem.InformationalMessage)
  89.                 continue;

  90.             else
  91.                 return false;
  92.         }
  93.         return true;
  94.     }

  95.     /** {@inheritDoc} */
  96.     @Override
  97.     public boolean get(URIish uri, CredentialItem... items)
  98.             throws UnsupportedCredentialItem {
  99.         boolean ok = true;
  100.         for (int i = 0; i < items.length && ok; i++) {
  101.             CredentialItem item = items[i];

  102.             if (item instanceof CredentialItem.StringType)
  103.                 ok = get((CredentialItem.StringType) item);

  104.             else if (item instanceof CredentialItem.CharArrayType)
  105.                 ok = get((CredentialItem.CharArrayType) item);

  106.             else if (item instanceof CredentialItem.YesNoType)
  107.                 ok = get((CredentialItem.YesNoType) item);

  108.             else if (item instanceof CredentialItem.InformationalMessage)
  109.                 ok = get((CredentialItem.InformationalMessage) item);

  110.             else
  111.                 throw new UnsupportedCredentialItem(uri, item.getPromptText());
  112.         }
  113.         return ok;
  114.     }

  115.     private boolean get(CredentialItem.StringType item) {
  116.         if (item.isValueSecure()) {
  117.             char[] v = cons.readPassword("%s: ", item.getPromptText()); //$NON-NLS-1$
  118.             if (v != null) {
  119.                 item.setValue(new String(v));
  120.                 return true;
  121.             } else {
  122.                 return false;
  123.             }
  124.         } else {
  125.             String v = cons.readLine("%s: ", item.getPromptText()); //$NON-NLS-1$
  126.             if (v != null) {
  127.                 item.setValue(v);
  128.                 return true;
  129.             } else {
  130.                 return false;
  131.             }
  132.         }
  133.     }

  134.     private boolean get(CredentialItem.CharArrayType item) {
  135.         if (item.isValueSecure()) {
  136.             char[] v = cons.readPassword("%s: ", item.getPromptText()); //$NON-NLS-1$
  137.             if (v != null) {
  138.                 item.setValueNoCopy(v);
  139.                 return true;
  140.             } else {
  141.                 return false;
  142.             }
  143.         } else {
  144.             String v = cons.readLine("%s: ", item.getPromptText()); //$NON-NLS-1$
  145.             if (v != null) {
  146.                 item.setValueNoCopy(v.toCharArray());
  147.                 return true;
  148.             } else {
  149.                 return false;
  150.             }
  151.         }
  152.     }

  153.     private boolean get(CredentialItem.InformationalMessage item) {
  154.         cons.printf("%s\n", item.getPromptText()); //$NON-NLS-1$
  155.         cons.flush();
  156.         return true;
  157.     }

  158.     private boolean get(CredentialItem.YesNoType item) {
  159.         String r = cons.readLine("%s [%s/%s]? ", item.getPromptText(), //$NON-NLS-1$
  160.                 CLIText.get().answerYes, CLIText.get().answerNo);
  161.         if (r != null) {
  162.             item.setValue(CLIText.get().answerYes.equalsIgnoreCase(r));
  163.             return true;
  164.         } else {
  165.             return false;
  166.         }
  167.     }
  168. }