be.atbash.ee.security.octopus.nimbus.jwk.KeyOperation Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2017-2020 Rudy De Busscher (https://www.atbash.be)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License 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 be.atbash.ee.security.octopus.nimbus.jwk;
import java.text.ParseException;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
/**
* Enumeration of key operations. Represents the {@code key_ops} parameter in a
* JSON Web Key (JWK).
*
* JWK operation values:
*
*
* - {@link #SIGN sign}
*
- {@link #VERIFY verify}
*
- {@link #ENCRYPT encrypt}
*
- {@link #DECRYPT decrypt}
*
- {@link #WRAP_KEY wrapKey}
*
- {@link #UNWRAP_KEY unwrapKey}
*
- {@link #DERIVE_KEY deriveKey}
*
- {@link #DERIVE_BITS deriveBits}
*
*
* Based on code by Vladimir Dzhuvinov
*/
public enum KeyOperation {
/**
* Compute signature or MAC.
*/
SIGN("sign"),
/**
* Verify signature or MAC.
*/
VERIFY("verify"),
/**
* Encrypt content.
*/
ENCRYPT("encrypt"),
/**
* Decrypt content and validate decryption, if applicable.
*/
DECRYPT("decrypt"),
/**
* Encrypt key.
*/
WRAP_KEY("wrapKey"),
/**
* Decrypt key and validate decryption, if applicable.
*/
UNWRAP_KEY("unwrapKey"),
/**
* Derive key.
*/
DERIVE_KEY("deriveKey"),
/**
* Derive bits not to be used as a key.
*/
DERIVE_BITS("deriveBits");
/**
* The key operation identifier.
*/
private final String identifier;
/**
* Creates a new key operation with the specified identifier.
*
* @param identifier The key operation identifier. Must not be
* {@code null}.
*/
KeyOperation(String identifier) {
if (identifier == null)
throw new IllegalArgumentException("The key operation identifier must not be null");
this.identifier = identifier;
}
/**
* Returns the identifier of this public key use.
*
* @return The identifier.
*/
public String identifier() {
return identifier;
}
/**
* @see #identifier()
*/
@Override
public String toString() {
return identifier();
}
/**
* Parses a key operation set from the specified JWK {@code key_ops}
* parameter value.
*
* @param sl The string list to parse. May be {@code null}.
* @return The key operation set, {@code null} if none.
* @throws ParseException If the string list couldn't be parsed to a
* valid key operation list.
*/
public static Set parse(final List sl)
throws ParseException {
if (sl == null) {
return null;
}
Set keyOps = new LinkedHashSet<>();
for (String s : sl) {
if (s == null) {
// skip
continue;
}
KeyOperation parsedOp = null;
for (KeyOperation op : KeyOperation.values()) {
if (s.equals(op.identifier())) {
parsedOp = op;
break;
}
}
if (parsedOp != null) {
keyOps.add(parsedOp);
} else {
throw new ParseException("Invalid JWK operation: " + s, 0);
}
}
return keyOps;
}
}