1 /* 2 * Copyright 2022 Google LLC 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: 7 * 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above 11 * copyright notice, this list of conditions and the following disclaimer 12 * in the documentation and/or other materials provided with the 13 * distribution. 14 * 15 * * Neither the name of Google LLC nor the names of its 16 * contributors may be used to endorse or promote products derived from 17 * this software without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 package com.google.auth.oauth2; 33 34 import java.io.IOException; 35 import java.util.Map; 36 import javax.annotation.Nullable; 37 38 /** An interface for 3rd party executable handling. */ 39 interface ExecutableHandler { 40 41 /** An interface for required fields needed to call 3rd party executables. */ 42 interface ExecutableOptions { 43 44 /** An absolute path to the command used to retrieve 3rd party tokens. */ getExecutableCommand()45 String getExecutableCommand(); 46 47 /** A set of process-local environment variable mappings to be set for the script to execute. */ getEnvironmentMap()48 Map<String, String> getEnvironmentMap(); 49 50 /** A timeout for waiting for the executable to finish, in milliseconds. */ getExecutableTimeoutMs()51 int getExecutableTimeoutMs(); 52 53 /** 54 * An output file path which points to the 3rd party credentials generated by the executable. 55 */ 56 @Nullable getOutputFilePath()57 String getOutputFilePath(); 58 } 59 60 /** 61 * Handles executing the 3rd party script and parsing the token from the response. 62 * 63 * @param options A set executable options for handling the executable. 64 * @return A 3rd party token. 65 */ retrieveTokenFromExecutable(ExecutableOptions options)66 String retrieveTokenFromExecutable(ExecutableOptions options) throws IOException; 67 } 68