1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.shiro.crypto.hash.format;
20
21 import org.apache.shiro.crypto.hash.Hash;
22
23 /**
24 * {@code HashFormat} that outputs <em>only</em> the hash's digest bytes in Base64 format. It does not print out
25 * anything else (salt, iterations, etc). This implementation is mostly provided as a convenience for
26 * command-line hashing.
27 *
28 * @since 1.2
29 */
30 public class Base64Format implements HashFormat {
31
32 /**
33 * Returns {@code hash != null ? hash.toBase64() : null}.
34 *
35 * @param hash the hash instance to format into a String.
36 * @return {@code hash != null ? hash.toBase64() : null}.
37 */
38 public String format(Hash hash) {
39 return hash != null ? hash.toBase64() : null;
40 }
41 }