mirror of
https://github.com/pgpainless/pgpainless.git
synced 2024-11-19 02:42:05 +01:00
Kotlin conversion: PDA
This commit is contained in:
parent
de73b3b00b
commit
a1a090028d
GPG key ID:
62BEE9264BF17311
2 changed files with 120 additions and 156 deletions
|
|
@ -1,156 +0,0 @@
|
||||||
// SPDX-FileCopyrightText: 2022 Paul Schaub <vanitasvitae@fsfe.org>
|
|
||||||
//
|
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
|
||||||
|
|
||||||
package org.pgpainless.decryption_verification.syntax_check;
|
|
||||||
|
|
||||||
import org.pgpainless.exception.MalformedOpenPgpMessageException;
|
|
||||||
import org.slf4j.Logger;
|
|
||||||
import org.slf4j.LoggerFactory;
|
|
||||||
|
|
||||||
import javax.annotation.Nonnull;
|
|
||||||
import javax.annotation.Nullable;
|
|
||||||
import java.util.ArrayList;
|
|
||||||
import java.util.Arrays;
|
|
||||||
import java.util.List;
|
|
||||||
import java.util.Stack;
|
|
||||||
|
|
||||||
import static org.pgpainless.decryption_verification.syntax_check.StackSymbol.msg;
|
|
||||||
import static org.pgpainless.decryption_verification.syntax_check.StackSymbol.terminus;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Pushdown Automaton for validating context-free languages.
|
|
||||||
* In PGPainless, this class is used to validate OpenPGP message packet sequences against the allowed syntax.
|
|
||||||
*
|
|
||||||
* @see <a href="https://www.rfc-editor.org/rfc/rfc4880#section-11.3">OpenPGP Message Syntax</a>
|
|
||||||
*/
|
|
||||||
public class PDA {
|
|
||||||
|
|
||||||
private static final Logger LOGGER = LoggerFactory.getLogger(PDA.class);
|
|
||||||
|
|
||||||
// right now we implement what rfc4880 specifies.
|
|
||||||
// TODO: Consider implementing what we proposed here:
|
|
||||||
// https://mailarchive.ietf.org/arch/msg/openpgp/uepOF6XpSegMO4c59tt9e5H1i4g/
|
|
||||||
private final Syntax syntax;
|
|
||||||
private final Stack<StackSymbol> stack = new Stack<>();
|
|
||||||
private final List<InputSymbol> inputs = new ArrayList<>(); // Track inputs for debugging / error reporting
|
|
||||||
private State state;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Default constructor which initializes the PDA to work with the {@link OpenPgpMessageSyntax}.
|
|
||||||
*/
|
|
||||||
public PDA() {
|
|
||||||
this(new OpenPgpMessageSyntax(), State.OpenPgpMessage, terminus, msg);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Construct a PDA with a custom {@link Syntax}, initial {@link State} and initial {@link StackSymbol StackSymbols}.
|
|
||||||
*
|
|
||||||
* @param syntax syntax
|
|
||||||
* @param initialState initial state
|
|
||||||
* @param initialStack zero or more initial stack items (get pushed onto the stack in order of appearance)
|
|
||||||
*/
|
|
||||||
public PDA(@Nonnull Syntax syntax, @Nonnull State initialState, @Nonnull StackSymbol... initialStack) {
|
|
||||||
this.syntax = syntax;
|
|
||||||
this.state = initialState;
|
|
||||||
for (StackSymbol symbol : initialStack) {
|
|
||||||
pushStack(symbol);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Process the next {@link InputSymbol}.
|
|
||||||
* This will either leave the PDA in the next state, or throw a {@link MalformedOpenPgpMessageException} if the
|
|
||||||
* input symbol is rejected.
|
|
||||||
*
|
|
||||||
* @param input input symbol
|
|
||||||
* @throws MalformedOpenPgpMessageException if the input symbol is rejected
|
|
||||||
*/
|
|
||||||
public void next(@Nonnull InputSymbol input)
|
|
||||||
throws MalformedOpenPgpMessageException {
|
|
||||||
StackSymbol stackSymbol = popStack();
|
|
||||||
try {
|
|
||||||
Transition transition = syntax.transition(state, input, stackSymbol);
|
|
||||||
state = transition.getNewState();
|
|
||||||
for (StackSymbol item : transition.getPushedItems()) {
|
|
||||||
pushStack(item);
|
|
||||||
}
|
|
||||||
inputs.add(input);
|
|
||||||
} catch (MalformedOpenPgpMessageException e) {
|
|
||||||
MalformedOpenPgpMessageException wrapped = new MalformedOpenPgpMessageException(
|
|
||||||
"Malformed message: After reading packet sequence " + Arrays.toString(inputs.toArray()) +
|
|
||||||
", token '" + input + "' is not allowed." +
|
|
||||||
"\nNo transition from state '" + state + "' with stack " + Arrays.toString(stack.toArray()) +
|
|
||||||
(stackSymbol != null ? "||'" + stackSymbol + "'." : "."), e);
|
|
||||||
LOGGER.debug("Invalid input '" + input + "'", wrapped);
|
|
||||||
throw wrapped;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Return the current state of the PDA.
|
|
||||||
*
|
|
||||||
* @return state
|
|
||||||
*/
|
|
||||||
public @Nonnull State getState() {
|
|
||||||
return state;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Peek at the stack, returning the topmost stack item without changing the stack.
|
|
||||||
*
|
|
||||||
* @return topmost stack item, or null if stack is empty
|
|
||||||
*/
|
|
||||||
public @Nullable StackSymbol peekStack() {
|
|
||||||
if (stack.isEmpty()) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
return stack.peek();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Return true, if the PDA is in a valid state (the OpenPGP message is valid).
|
|
||||||
*
|
|
||||||
* @return true if valid, false otherwise
|
|
||||||
*/
|
|
||||||
public boolean isValid() {
|
|
||||||
return getState() == State.Valid && stack.isEmpty();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Throw a {@link MalformedOpenPgpMessageException} if the pda is not in a valid state right now.
|
|
||||||
*
|
|
||||||
* @throws MalformedOpenPgpMessageException if the pda is not in an acceptable state
|
|
||||||
*/
|
|
||||||
public void assertValid() throws MalformedOpenPgpMessageException {
|
|
||||||
if (!isValid()) {
|
|
||||||
throw new MalformedOpenPgpMessageException("Pushdown Automaton is not in an acceptable state: " + toString());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Pop an item from the stack.
|
|
||||||
*
|
|
||||||
* @return stack item
|
|
||||||
*/
|
|
||||||
private StackSymbol popStack() {
|
|
||||||
if (stack.isEmpty()) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
return stack.pop();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Push an item onto the stack.
|
|
||||||
*
|
|
||||||
* @param item item
|
|
||||||
*/
|
|
||||||
private void pushStack(StackSymbol item) {
|
|
||||||
stack.push(item);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public String toString() {
|
|
||||||
return "State: " + state + " Stack: " + stack;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -0,0 +1,120 @@
|
||||||
|
// SPDX-FileCopyrightText: 2023 Paul Schaub <vanitasvitae@fsfe.org>
|
||||||
|
//
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
package org.pgpainless.decryption_verification.syntax_check
|
||||||
|
|
||||||
|
import org.pgpainless.exception.MalformedOpenPgpMessageException
|
||||||
|
import org.slf4j.LoggerFactory
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Pushdown Automaton for validating context-free languages.
|
||||||
|
* In PGPainless, this class is used to validate OpenPGP message packet sequences against the allowed syntax.
|
||||||
|
*
|
||||||
|
* See [OpenPGP Message Syntax](https://www.rfc-editor.org/rfc/rfc4880#section-11.3)
|
||||||
|
*/
|
||||||
|
class PDA constructor(
|
||||||
|
private val syntax: Syntax,
|
||||||
|
private val stack: ArrayDeque<StackSymbol>,
|
||||||
|
private val inputs: MutableList<InputSymbol>,
|
||||||
|
private var state: State
|
||||||
|
) {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Construct a PDA with a custom [Syntax], initial [State] and initial [StackSymbols][StackSymbol].
|
||||||
|
*
|
||||||
|
* @param syntax syntax
|
||||||
|
* @param initialState initial state
|
||||||
|
* @param initialStack zero or more initial stack items (get pushed onto the stack in order of appearance)
|
||||||
|
*/
|
||||||
|
constructor(syntax: Syntax, initialState: State, vararg initialStack: StackSymbol): this (
|
||||||
|
syntax, ArrayDeque(initialStack.toList().reversed()), mutableListOf(), initialState)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Default constructor which initializes the PDA to work with the [OpenPgpMessageSyntax].
|
||||||
|
*/
|
||||||
|
constructor(): this(OpenPgpMessageSyntax(), State.OpenPgpMessage, StackSymbol.terminus, StackSymbol.msg)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Process the next [InputSymbol].
|
||||||
|
* This will either leave the PDA in the next state, or throw a [MalformedOpenPgpMessageException] if the
|
||||||
|
* input symbol is rejected.
|
||||||
|
*
|
||||||
|
* @param input input symbol
|
||||||
|
* @throws MalformedOpenPgpMessageException if the input symbol is rejected
|
||||||
|
*/
|
||||||
|
fun next(input: InputSymbol) {
|
||||||
|
val stackSymbol = popStack()
|
||||||
|
try {
|
||||||
|
val transition = syntax.transition(state, input, stackSymbol)
|
||||||
|
state = transition.newState
|
||||||
|
for (item in transition.pushedItems) {
|
||||||
|
pushStack(item)
|
||||||
|
}
|
||||||
|
inputs.add(input)
|
||||||
|
} catch (e: MalformedOpenPgpMessageException) {
|
||||||
|
val stackFormat = if (stackSymbol != null) {
|
||||||
|
"${stack.joinToString()}||$stackSymbol"
|
||||||
|
} else {
|
||||||
|
stack.joinToString()
|
||||||
|
}
|
||||||
|
val wrapped = MalformedOpenPgpMessageException(
|
||||||
|
"Malformed message: After reading packet sequence ${inputs.joinToString()}, token '$input' is not allowed.\n" +
|
||||||
|
"No transition from state '$state' with stack $stackFormat", e)
|
||||||
|
LOGGER.debug("Invalid input '$input'", wrapped)
|
||||||
|
throw wrapped
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Peek at the stack, returning the topmost stack item without changing the stack.
|
||||||
|
*
|
||||||
|
* @return topmost stack item, or null if stack is empty
|
||||||
|
*/
|
||||||
|
fun peekStack(): StackSymbol? = stack.firstOrNull()
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return true, if the PDA is in a valid state (the OpenPGP message is valid).
|
||||||
|
*
|
||||||
|
* @return true if valid, false otherwise
|
||||||
|
*/
|
||||||
|
fun isValid(): Boolean = state == State.Valid && stack.isEmpty()
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Throw a [MalformedOpenPgpMessageException] if the pda is not in a valid state right now.
|
||||||
|
*
|
||||||
|
* @throws MalformedOpenPgpMessageException if the pda is not in an acceptable state
|
||||||
|
*/
|
||||||
|
fun assertValid() {
|
||||||
|
if (!isValid()) {
|
||||||
|
throw MalformedOpenPgpMessageException("Pushdown Automaton is not in an acceptable state: ${toString()}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Pop an item from the stack.
|
||||||
|
*
|
||||||
|
* @return stack item
|
||||||
|
*/
|
||||||
|
private fun popStack(): StackSymbol? {
|
||||||
|
return stack.removeFirstOrNull()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Push an item onto the stack.
|
||||||
|
*
|
||||||
|
* @param item item
|
||||||
|
*/
|
||||||
|
private fun pushStack(item: StackSymbol) {
|
||||||
|
stack.addFirst(item)
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun toString(): String {
|
||||||
|
return "State: $state Stack: ${stack.joinToString()}"
|
||||||
|
}
|
||||||
|
|
||||||
|
companion object {
|
||||||
|
@JvmStatic
|
||||||
|
private val LOGGER = LoggerFactory.getLogger(PDA::class.java)
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in a new issue