1 /*
2 * Copyright (C) 2018, Salesforce.
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43 package org.eclipse.jgit.lib;
44
45 import static java.nio.charset.StandardCharsets.US_ASCII;
46
47 import java.io.Serializable;
48
49 import org.eclipse.jgit.annotations.NonNull;
50
51 /**
52 * A structure for holding GPG signature together with additional related data.
53 *
54 * @since 5.3
55 */
56 public class GpgSignature implements Serializable {
57
58 private static final long serialVersionUID = 1L;
59
60 private byte[] signature;
61
62 /**
63 * Creates a new instance with the specified signature
64 *
65 * @param signature
66 * the signature
67 */
68 public GpgSignature(@NonNull byte[] signature) {
69 this.signature = signature;
70 }
71
72 /**
73 * Format for Git storage.
74 * <p>
75 * This returns the ASCII Armor as per
76 * https://tools.ietf.org/html/rfc4880#section-6.2.
77 * </p>
78 *
79 * @return a string of the signature ready to be embedded in a Git object
80 */
81 public String toExternalString() {
82 return new String(signature, US_ASCII);
83 }
84
85 /** {@inheritDoc} */
86 @Override
87 @SuppressWarnings("nls")
88 public String toString() {
89 final StringBuilder r = new StringBuilder();
90
91 r.append("GpgSignature[");
92 r.append(
93 this.signature != null ? "length " + signature.length : "null");
94 r.append("]");
95
96 return r.toString();
97 }
98 }