Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* (c) Copyright 2017 EntIT Software LLC, a Micro Focus company, L.P.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Apache License v2.0 which accompany this distribution.
*
* The Apache License is available 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 io.cloudslang.content.amazon.actions.signature;
import com.hp.oo.sdk.content.annotations.Action;
import com.hp.oo.sdk.content.annotations.Output;
import com.hp.oo.sdk.content.annotations.Param;
import com.hp.oo.sdk.content.annotations.Response;
import com.hp.oo.sdk.content.plugin.ActionMetadata.MatchType;
import com.hp.oo.sdk.content.plugin.ActionMetadata.ResponseType;
import io.cloudslang.content.amazon.entities.aws.AuthorizationHeader;
import io.cloudslang.content.amazon.entities.constants.Outputs;
import io.cloudslang.content.amazon.entities.inputs.CommonInputs;
import io.cloudslang.content.amazon.entities.inputs.InputsWrapper;
import io.cloudslang.content.amazon.services.AmazonSignatureService;
import io.cloudslang.content.amazon.utils.ExceptionProcessor;
import io.cloudslang.content.amazon.utils.OutputsUtil;
import java.util.HashMap;
import java.util.Map;
import static io.cloudslang.content.amazon.utils.InputsUtil.getHeadersOrQueryParamsMap;
import static io.cloudslang.content.amazon.entities.constants.Constants.AwsParams.AUTHORIZATION_HEADER_RESULT;
import static io.cloudslang.content.amazon.entities.constants.Constants.AwsParams.HEADER_DELIMITER;
import static io.cloudslang.content.amazon.entities.constants.Constants.AwsParams.SIGNATURE_RESULT;
import static io.cloudslang.content.amazon.entities.constants.Constants.Miscellaneous.AMPERSAND;
import static io.cloudslang.content.amazon.entities.constants.Constants.Miscellaneous.COLON;
import static io.cloudslang.content.amazon.entities.constants.Constants.Miscellaneous.EQUAL;
import static io.cloudslang.content.amazon.entities.constants.Inputs.CommonInputs.CREDENTIAL;
import static io.cloudslang.content.amazon.entities.constants.Inputs.CommonInputs.ENDPOINT;
import static io.cloudslang.content.amazon.entities.constants.Inputs.CommonInputs.HEADERS;
import static io.cloudslang.content.amazon.entities.constants.Inputs.CommonInputs.IDENTITY;
import static io.cloudslang.content.amazon.entities.constants.Inputs.CommonInputs.PREFIX;
import static io.cloudslang.content.amazon.entities.constants.Inputs.CommonInputs.QUERY_PARAMS;
import static io.cloudslang.content.amazon.entities.constants.Inputs.CustomInputs.AMAZON_API;
import static io.cloudslang.content.amazon.entities.constants.Inputs.CustomInputs.DATE;
import static io.cloudslang.content.amazon.entities.constants.Inputs.CustomInputs.HTTP_VERB;
import static io.cloudslang.content.amazon.entities.constants.Inputs.CustomInputs.PAYLOAD_HASH;
import static io.cloudslang.content.amazon.entities.constants.Inputs.CustomInputs.URI;
import static io.cloudslang.content.amazon.entities.constants.Inputs.IamInputs.SECURITY_TOKEN;
/**
* Created by Mihai Tusa.
* 8/8/2016.
*/
public class ComputeSignatureV4 {
/**
* Computes the AWS Signature Version 4 used to authenticate requests by using the authorization header.
* For this signature type the checksum of the entire payload is computed.
* Note: The "authorizationHeader" output's value should be added in the "Authorization" header.
*
* @param endpoint Service endpoint used to compute the signature. Ex.: "ec2.amazonaws.com", "s3.amazonaws.com"
* Default: "ec2.amazonaws.com"
* @param identity ID of the secret access key associated with your Amazon AWS or IAM account.
* @param credential Secret access key associated with your Amazon AWS or IAM account.
* @param amazonApi Amazon API corresponding to where the request is send.
* Examples: "ec2", "s3"
* @param uri request's relative URI. The URI should be from the service endpoint to the query params.
* Default: "/"
* @param httpVerb Method used for the request. You need to specify this with upper case.
* Valid values: GET, DELETE, HEAD, POST, PUT
* Default: GET
* @param payloadHash Payload's hash that will be included in the signature. The hashing should be computed using
* the "SHA-256" hashing algorithm and then hex encoded.
* @param securityToken URI-encoded session token. The string you received from AWS STS when you obtained temporary
* security credentials.
* @param date Date of the request. The date should be also included in the "x-amz-date" header and should
* be in the in the YYYYMMDD'T'HHMMSS'Z' format form UTC time zone.
* Example: 20150416T112043Z for April 16, 2015 11:20:43 AM UTC
* Default: The current date and time in UTC time zone
* @param headers String containing the headers to use for the request separated by new line (CRLF). The header
* name-value pair will be separated by ":".
* Format: Conforming with HTTP standard for headers (RFC 2616)
* Examples: Accept:text/plain
* @param queryParams String containing query parameters that will be appended to the URL. The names and the values
* must not be URL encoded because if they are encoded then a double encoded will occur. The
* separator between name-value pairs is "&" symbol. The query name will be separated from query
* value by "="
* Examples: parameterName1=parameterValue1¶meterName2=parameterValue2;
* @param prefix Optional - used to sign request for Simple Storage Service (S3). This prefix will precede the
* endpoint when made calls for specific bucket (for e.g. if prefix is "mybucket" then the endpoint
* where the request are made will be "mybucket.s3.amazonaws.com")
* Default: ""
* @return A map, with strings as keys and values, that contains: outcome of the action, returnCode of the operation
* or failure message, the exception if there is one, signature value and authorization header value
*/
@Action(name = "Compute Signature V4",
outputs = {
@Output(Outputs.RETURN_CODE),
@Output(Outputs.RETURN_RESULT),
@Output(Outputs.EXCEPTION),
@Output(SIGNATURE_RESULT),
@Output(AUTHORIZATION_HEADER_RESULT)
},
responses = {
@Response(text = Outputs.SUCCESS, field = Outputs.RETURN_CODE, value = Outputs.SUCCESS_RETURN_CODE,
matchType = MatchType.COMPARE_EQUAL, responseType = ResponseType.RESOLVED),
@Response(text = Outputs.FAILURE, field = Outputs.RETURN_CODE, value = Outputs.FAILURE_RETURN_CODE,
matchType = MatchType.COMPARE_EQUAL, responseType = ResponseType.ERROR, isOnFail = true)
})
public Map execute(@Param(value = ENDPOINT) String endpoint,
@Param(value = IDENTITY, required = true) String identity,
@Param(value = CREDENTIAL, required = true, encrypted = true) String credential,
@Param(value = HEADERS) String headers,
@Param(value = QUERY_PARAMS) String queryParams,
@Param(value = AMAZON_API) String amazonApi,
@Param(value = URI) String uri,
@Param(value = HTTP_VERB) String httpVerb,
@Param(value = PAYLOAD_HASH) String payloadHash,
@Param(value = DATE) String date,
@Param(value = SECURITY_TOKEN) String securityToken,
@Param(value = PREFIX) String prefix) {
try {
Map headersMap = getHeadersOrQueryParamsMap(new HashMap(), headers, HEADER_DELIMITER, COLON, true);
Map queryParamsMap = getHeadersOrQueryParamsMap(new HashMap(), queryParams, AMPERSAND, EQUAL, false);
CommonInputs commonInputs = new CommonInputs.Builder()
.withEndpoint(endpoint, amazonApi, prefix)
.withIdentity(identity)
.withCredential(credential)
.build();
InputsWrapper wrapper = new InputsWrapper.Builder()
.withCommonInputs(commonInputs)
.withApiService(amazonApi)
.withRequestUri(uri)
.withHttpVerb(httpVerb)
.withRequestPayload(payloadHash)
.withDate(date)
.withHeaders(headers)
.withQueryParams(queryParams)
.withSecurityToken(securityToken)
.build();
AuthorizationHeader authorizationHeader = new AmazonSignatureService()
.signRequestHeaders(wrapper, headersMap, queryParamsMap);
return OutputsUtil.populateSignatureResultsMap(authorizationHeader);
} catch (Exception exception) {
return ExceptionProcessor.getExceptionResult(exception);
}
}
}
