#include "enigma.h"
#include "score.h"
#include <stddef.h>

Data Structures
struct	EnigmaCrackParams
	A structure representing a configuration for cracking an Enigma cipher. More...

Macros
#define	ENIGMA_FLAG_X_SEPARATED 16
	Flag indicating that the plaintext words are separated by X's.

#define	ENIGMA_DICTIONARY_EXISTS 1
	Flag indicating that the dictionary exists, utilized in enigma_crack_params_validate().

#define	ENIGMA_N_GRAMS_EXIST 2
	Flag indicating that the n-grams exist, utilized in enigma_crack_params_validate().

#define	ENIGMA_IOC_FREQS_EXIST 4
	Flag indicating that the IOC frequencies exist, utilized in enigma_crack_params_validate().

#define	ENIGMA_CIPHERTEXT_EXISTS 8
	Flag indicating that the ciphertext exists, utilized in enigma_crack_params_validate().

#define	ENIGMA_SCORE_BOUNDS_EXIST 16
	Flag indicating that the score bounds exist, utilized in enigma_crack_params_validate().

#define	ENIGMA_ROTORS_DEFINED 32
	Flag indicating that hypothesized rotors are defined, utilized in enigma_crack_params_validate() and enigma_crack_auto().

#define	ENIGMA_ROTOR_POSITIONS_DEFINED 64
	Flag indicating that hypothesized rotor positions are defined, utilized in enigma_crack_params_validate() and enigma_crack_auto().

#define	ENIGMA_REFLECTOR_DEFINED 128
	Flag indicating that a hypothesized reflector is defined, utilized in enigma_crack_params_validate() and enigma_crack_auto().

#define	ENIGMA_PLUGBOARD_DEFINED 256
	Flag indicating that hypothesized plugboard settings are defined, utilized in enigma_crack_params_validate() and enigma_crack_auto().

Functions
EnigmaCrackParams *	enigma_crack_params_new (void)
	Create a new EnigmaCrackParams structure.

int	enigma_crack_params_validate (const EnigmaCrackParams *)
	Check what capabilities the EnigmaCrackParams structure has.

int	enigma_crack_rotor (EnigmaCrackParams , int, float()(const EnigmaCrackParams , const char ))
	Crack the rotor using a scoring function.

int	enigma_crack_rotors (EnigmaCrackParams , float()(const EnigmaCrackParams , const char ))
	Crack the rotor order using a scoring function.

int	enigma_crack_rotor_position (EnigmaCrackParams , int, float(scoreFunc)(const EnigmaCrackParams , const char ))
	Crack a rotor's position using a scoring function.

int	enigma_crack_rotor_positions (EnigmaCrackParams , float()(const EnigmaCrackParams , const char ))
	Crack the rotor positions using a scoring function.

int	enigma_crack_reflector (EnigmaCrackParams , float()(const EnigmaCrackParams , const char ))
	Crack the reflector using a scoring function.

int	enigma_crack_plugboard (EnigmaCrackParams , float()(const EnigmaCrackParams , const char ))
	Crack the plugboard using a scoring function.

int	enigma_dict_match (const EnigmaCrackParams , const char )
	Checks if multiple words from the dictionary are present in the plaintext.

int	enigma_find_potential_indices (const char , const char , int *)
	Finds potential indices in the ciphertext where the known plaintext may exist.

float	enigma_freq (const char *, int)
	Calculate the frequency of characters in the plaintext.

int	enigma_letter_freq (const EnigmaCrackParams , const char )
	Check if the letter frequencies in the plaintext match target frequencies within an offset.

int	enigma_score_append (EnigmaCrackParams , Enigma , const char *, float)
	Append a score to an EnigmaScoreList.

int	enigma_score_flags (const EnigmaCrackParams , const char )
	Get the flags for a given plaintext based on the crack configuration.

const Enigma *	enigma_crack_get_enigma (const EnigmaCrackParams *)
	Get the enigma field in the given EnigmaCrackParams struct.

const EnigmaScoreList *	enigma_crack_get_score_list (const EnigmaCrackParams *)
	Get the score_list field in the given EnigmaCrackParams struct.

const char **	enigma_crack_get_dictionary (const EnigmaCrackParams *)
	Get the dictionary field in the given EnigmaCrackParams struct.

size_t	enigma_crack_get_dictionary_length (const EnigmaCrackParams *)
	Get the `dictionary_length` field in the given EnigmaCrackParams struct.

const float *	enigma_crack_get_ngrams (const EnigmaCrackParams *)
	Get the ngrams field in the given EnigmaCrackParams struct.

int	enigma_crack_get_n (const EnigmaCrackParams *)
	Get the n field in the given EnigmaCrackParams struct.

size_t	enigma_crack_get_ngrams_length (const EnigmaCrackParams *)
	Get the ngrams_length field in the given EnigmaCrackParams struct.

const char *	enigma_crack_get_ciphertext (const EnigmaCrackParams *)
	Get the ciphertext field in the given EnigmaCrackParams struct.

size_t	enigma_crack_get_ciphertext_length (const EnigmaCrackParams *)
	Get the ciphertext_length field in the given EnigmaCrackParams struct.

int	enigma_crack_get_flags (const EnigmaCrackParams *)
	Get the flags field in the given EnigmaCrackParams struct.

const float *	enigma_crack_get_frequency_targets (const EnigmaCrackParams *)
	Get the frequency_targets field in the given EnigmaCrackParams struct.

float	enigma_crack_get_min_score (const EnigmaCrackParams *)
	Get the min_score field in the given EnigmaCrackParams struct.

float	enigma_crack_get_max_score (const EnigmaCrackParams *)
	Get the max_score field in the given EnigmaCrackParams struct.

float	enigma_crack_get_target_score (const EnigmaCrackParams *)
	Get the target_score field in the given EnigmaCrackParams struct.

const char *	enigma_crack_get_known_plaintext (const EnigmaCrackParams *)
	Get the known_plaintext field in the given EnigmaCrackParams struct.

size_t	enigma_crack_get_known_plaintext_length (const EnigmaCrackParams *)
	Get the known_plaintext_length field in the given EnigmaCrackParams struct.

int	enigma_crack_set_enigma (EnigmaCrackParams , Enigma )
	Set the enigma field in the given EnigmaCrackParams struct.

int	enigma_crack_set_score_list (EnigmaCrackParams , EnigmaScoreList )
	Set the score_list field in the given EnigmaCrackParams struct.

int	enigma_crack_set_dictionary (EnigmaCrackParams , const char *, size_t)
	Set the dictionary field in the given EnigmaCrackParams struct.

int	enigma_crack_set_ngrams (EnigmaCrackParams , float , int, size_t)
	Set the ngrams field in the given EnigmaCrackParams struct.

int	enigma_crack_set_n (EnigmaCrackParams *, int)
	Set the n field in the given EnigmaCrackParams struct.

int	enigma_crack_set_ciphertext (EnigmaCrackParams , const char , size_t)
	Set the ciphertext field in the given EnigmaCrackParams struct.

int	enigma_crack_set_flags (EnigmaCrackParams *, int)
	Set the flags field in the given EnigmaCrackParams struct.

int	enigma_crack_set_frequency_targets (EnigmaCrackParams , float )
	Set the frequency targets field in the given EnigmaCrackParams struct.

int	enigma_crack_set_min_score (EnigmaCrackParams *, float)
	Set the minimum score field in the given EnigmaCrackParams struct.

int	enigma_crack_set_max_score (EnigmaCrackParams *, float)
	Set the maximum score field in the given EnigmaCrackParams struct.

int	enigma_crack_set_target_score (EnigmaCrackParams *, float)
	Set the target score field in the given EnigmaCrackParams struct.

int	enigma_crack_set_known_plaintext (EnigmaCrackParams , const char , size_t)
	Set the known plaintext field in the given EnigmaCrackParams struct.

Detailed Description

Header file for cracking Enigma machine configurations.

Macro Definition Documentation

◆ ENIGMA_CIPHERTEXT_EXISTS

#define ENIGMA_CIPHERTEXT_EXISTS 8

Flag indicating that the ciphertext exists, utilized in enigma_crack_params_validate().

◆ ENIGMA_DICTIONARY_EXISTS

#define ENIGMA_DICTIONARY_EXISTS 1

Flag indicating that the dictionary exists, utilized in enigma_crack_params_validate().

◆ ENIGMA_FLAG_X_SEPARATED

#define ENIGMA_FLAG_X_SEPARATED 16

Flag indicating that the plaintext words are separated by X's.

◆ ENIGMA_IOC_FREQS_EXIST

#define ENIGMA_IOC_FREQS_EXIST 4

Flag indicating that the IOC frequencies exist, utilized in enigma_crack_params_validate().

◆ ENIGMA_N_GRAMS_EXIST

#define ENIGMA_N_GRAMS_EXIST 2

Flag indicating that the n-grams exist, utilized in enigma_crack_params_validate().

◆ ENIGMA_PLUGBOARD_DEFINED

#define ENIGMA_PLUGBOARD_DEFINED 256

Flag indicating that hypothesized plugboard settings are defined, utilized in enigma_crack_params_validate() and enigma_crack_auto().

◆ ENIGMA_REFLECTOR_DEFINED

#define ENIGMA_REFLECTOR_DEFINED 128

Flag indicating that a hypothesized reflector is defined, utilized in enigma_crack_params_validate() and enigma_crack_auto().

◆ ENIGMA_ROTOR_POSITIONS_DEFINED

#define ENIGMA_ROTOR_POSITIONS_DEFINED 64

Flag indicating that hypothesized rotor positions are defined, utilized in enigma_crack_params_validate() and enigma_crack_auto().

◆ ENIGMA_ROTORS_DEFINED

#define ENIGMA_ROTORS_DEFINED 32

Flag indicating that hypothesized rotors are defined, utilized in enigma_crack_params_validate() and enigma_crack_auto().

◆ ENIGMA_SCORE_BOUNDS_EXIST

#define ENIGMA_SCORE_BOUNDS_EXIST 16

Flag indicating that the score bounds exist, utilized in enigma_crack_params_validate().

Function Documentation

◆ enigma_crack_get_ciphertext()

const char * enigma_crack_get_ciphertext ( const EnigmaCrackParams * cfg )

Get the ciphertext field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance

Returns: The ciphertext field, or NULL if cfg is NULL

◆ enigma_crack_get_ciphertext_length()

size_t enigma_crack_get_ciphertext_length ( const EnigmaCrackParams * cfg )

Get the ciphertext_length field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance

Returns: The ciphertext_length field, or ENIGMA_FAILURE if cfg is NULL

◆ enigma_crack_get_dictionary()

const char ** enigma_crack_get_dictionary ( const EnigmaCrackParams * cfg )

Get the dictionary field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance

Returns: The dictionary field, or NULL if cfg is NULL.

◆ enigma_crack_get_dictionary_length()

size_t enigma_crack_get_dictionary_length ( const EnigmaCrackParams * cfg )

Get the dictionary_length field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance

Returns: The dictionary_length field, or ENIGMA_FAILURE if cfg is NULL.

◆ enigma_crack_get_enigma()

const Enigma * enigma_crack_get_enigma ( const EnigmaCrackParams * cfg )

Get the enigma field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance

Returns: The enigma field, or NULL if cfg is NULL.

◆ enigma_crack_get_flags()

int enigma_crack_get_flags ( const EnigmaCrackParams * cfg )

Get the flags field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance

Returns: The flags field, or ENIGMA_FAILURE if cfg is NULL

◆ enigma_crack_get_frequency_targets()

const float * enigma_crack_get_frequency_targets ( const EnigmaCrackParams * cfg )

Get the frequency_targets field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance

Returns: The frequency_targets field, or NULL if cfg is NULL

◆ enigma_crack_get_known_plaintext()

const char * enigma_crack_get_known_plaintext ( const EnigmaCrackParams * cfg )

Get the known_plaintext field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance

Returns: The known_plaintext field, or NULL if cfg is NULL

◆ enigma_crack_get_known_plaintext_length()

size_t enigma_crack_get_known_plaintext_length ( const EnigmaCrackParams * cfg )

Get the known_plaintext_length field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance

Returns: The known_plaintext_length field, or ENIGMA_FAILURE if cfg is NULL

◆ enigma_crack_get_max_score()

float enigma_crack_get_max_score ( const EnigmaCrackParams * cfg )

Get the max_score field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance

Returns: The max_score field, or ENIGMA_FAILURE if cfg is NULL

◆ enigma_crack_get_min_score()

float enigma_crack_get_min_score ( const EnigmaCrackParams * cfg )

Get the min_score field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance

Returns: The min_score field, or ENIGMA_FAILURE if cfg is NULL

◆ enigma_crack_get_n()

int enigma_crack_get_n ( const EnigmaCrackParams * cfg )

Get the n field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance

Returns: The n field, or ENIGMA_FAILURE if cfg is NULL

◆ enigma_crack_get_ngrams()

const float * enigma_crack_get_ngrams ( const EnigmaCrackParams * cfg )

Get the ngrams field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance

Returns: The ngrams field, or NULL if cfg is NULL.

◆ enigma_crack_get_ngrams_length()

size_t enigma_crack_get_ngrams_length ( const EnigmaCrackParams * cfg )

Get the ngrams_length field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance

Returns: The ngrams_length field, or ENIGMA_FAILURE if cfg is NULL

◆ enigma_crack_get_score_list()

const EnigmaScoreList * enigma_crack_get_score_list ( const EnigmaCrackParams * cfg )

Get the score_list field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance

Returns: The scores field, or NULL if cfg is NULL.

◆ enigma_crack_get_target_score()

float enigma_crack_get_target_score ( const EnigmaCrackParams * cfg )

Get the target_score field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance

Returns: The target_score field, or ENIGMA_FAILURE if cfg is NULL

◆ enigma_crack_params_new()

EnigmaCrackParams * enigma_crack_params_new ( void )

Create a new EnigmaCrackParams structure.

This function allocates memory for a new EnigmaCrackParams structure.

Returns: Pointer to the newly created EnigmaCrackParams structure, or NULL on failure.

◆ enigma_crack_params_validate()

int enigma_crack_params_validate ( const EnigmaCrackParams * cfg )

Check what capabilities the EnigmaCrackParams structure has.

This function checks if the EnigmaCrackParams structure is able to be used to perform cracking operations. The following flags are checked:

ENIGMA_DICTIONARY_EXISTS: The dictionary exists and is not empty.
ENIGMA_N_GRAMS_EXIST: The n-grams exist and are valid.
ENIGMA_IOC_FREQS_EXIST: The IOC frequencies exist and are valid.
ENIGMA_CIPHERTEXT_EXISTS: The ciphertext exists and is not empty.
ENIGMA_SCORE_BOUNDS_EXIST: The score bounds exist and are valid.

Parameters

cfg	Pointer to the EnigmaCrackParams structure.

Returns: A bitmask indicating the capabilities of the EnigmaCrackParams structure.

◆ enigma_crack_plugboard()

int enigma_crack_plugboard	(	EnigmaCrackParams *	cfg,
		float()(const EnigmaCrackParams , const char *)	scoreFunc
	)

Crack the plugboard using a scoring function.

This function attempts to determine the plugboard settings used in the Enigma machine by evaluating all possible plugboard configurations and scoring the resulting plaintext using the provided scoring function.

Parameters

cfg	Pointer to the cracking configuration structure.
scoreFunc	Function pointer to the scoring function to use.

Returns: ENIGMA_SUCCESS on success, ENIGMA_FAILURE on failure.

◆ enigma_crack_reflector()

int enigma_crack_reflector	(	EnigmaCrackParams *	cfg,
		float()(const EnigmaCrackParams , const char *)	scoreFunc
	)

Crack the reflector using a scoring function.

This function attempts to determine the reflector used in the Enigma machine by evaluating all possible reflectors and scoring the resulting plaintext using the provided scoring function.

Parameters

cfg	Pointer to the cracking configuration structure.
scoreFunc	Function pointer to the scoring function to use.

Returns: ENIGMA_SUCCESS on success, ENIGMA_FAILURE on failure.

◆ enigma_crack_rotor()

int enigma_crack_rotor	(	EnigmaCrackParams *	cfg,
		int	targetRotor,
		float()(const EnigmaCrackParams , const char *)	scoreFunc
	)

Crack the rotor using a scoring function.

This function attempts to determine the rotor used in the Enigma machine by evaluating all possible rotors and scoring the resulting plaintext using the provided scoring function.

Parameters

cfg	Pointer to the cracking configuration structure.
targetRotor	The index of the rotor to crack (0-based).
scoreFunc	Function pointer to the scoring function to use.

Returns: ENIGMA_SUCCESS on success, ENIGMA_FAILURE on failure.

◆ enigma_crack_rotor_position()

int enigma_crack_rotor_position	(	EnigmaCrackParams *	cfg,
		int	rotor,
		float()(const EnigmaCrackParams , const char *)	scoreFunc
	)

Crack a rotor's position using a scoring function.

This function attempts to determine the starting position of the given rotor by evaluating all possible rotor positions and scoring the resulting plaintext using the provided scoring function.

Parameters

cfg	Pointer to the cracking configuration structure.
scoreFunc	Function pointer to the scoring function to use.

Returns: ENIGMA_SUCCESS on success, ENIGMA_FAILURE on failure.

◆ enigma_crack_rotor_positions()

int enigma_crack_rotor_positions	(	EnigmaCrackParams *	cfg,
		float()(const EnigmaCrackParams , const char *)	scoreFunc
	)

Crack the rotor positions using a scoring function.

This function attempts to determine the rotor starting positions of the Enigma machine by evaluating all possible rotor positions and scoring the resulting plaintext using the provided scoring function.

Parameters

cfg	Pointer to the cracking configuration structure.
scoreFunc	Function pointer to the scoring function to use.

Returns: ENIGMA_SUCCESS on success, ENIGMA_FAILURE on failure.

◆ enigma_crack_rotors()

int enigma_crack_rotors	(	EnigmaCrackParams *	cfg,
		float()(const EnigmaCrackParams , const char *)	scoreFunc
	)

Crack the rotor order using a scoring function.

This function attempts to determine the order of rotors used in the Enigma machine by evaluating all possible rotor orders and scoring the resulting plaintext using the provided scoring function.

Parameters

cfg	Pointer to the cracking configuration structure.
scoreFunc	Function pointer to the scoring function to use.

Returns: ENIGMA_SUCCESS on success, ENIGMA_FAILURE on failure.

◆ enigma_crack_set_ciphertext()

int enigma_crack_set_ciphertext	(	EnigmaCrackParams *	cfg,
		const char *	ciphertext,
		size_t	length
	)

Set the ciphertext field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance
ciphertext	The ciphertext string
length	The length of the ciphertext string

Returns: ENIGMA_SUCCESS on success, ENIGMA_FAILURE on failure

◆ enigma_crack_set_dictionary()

int enigma_crack_set_dictionary	(	EnigmaCrackParams *	cfg,
		const char **	dictionary,
		size_t	length
	)

Set the dictionary field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance
dictionary	The dictionary array
length	The length of the dictionary array

Returns: 0 on success, -1 on failure

◆ enigma_crack_set_enigma()

int enigma_crack_set_enigma	(	EnigmaCrackParams *	cfg,
		Enigma *	enigma
	)

Set the enigma field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance
enigma	The Enigmainstance

Returns: ENIGMA_SUCCESS on success, ENIGMA_FAILURE on failure

◆ enigma_crack_set_flags()

int enigma_crack_set_flags	(	EnigmaCrackParams *	cfg,
		int	flags
	)

Set the flags field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance
flags	The flags value

Returns: ENIGMA_SUCCESS on success, ENIGMA_FAILURE on failure

◆ enigma_crack_set_frequency_targets()

int enigma_crack_set_frequency_targets	(	EnigmaCrackParams *	cfg,
		float *	frequencyTargets
	)

Set the frequency targets field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance
frequencyTargets	The frequency targets array

Returns: ENIGMA_SUCCESS on success, ENIGMA_FAILURE on failure

◆ enigma_crack_set_known_plaintext()

int enigma_crack_set_known_plaintext	(	EnigmaCrackParams *	cfg,
		const char *	knownPlaintext,
		size_t	length
	)

Set the known plaintext field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance
knownPlaintext	The known plaintext string
length	The length of the known plaintext string

Returns: ENIGMA_SUCCESS on success, ENIGMA_FAILURE on failure

◆ enigma_crack_set_max_score()

int enigma_crack_set_max_score	(	EnigmaCrackParams *	cfg,
		float	maxScore
	)

Set the maximum score field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance
maxScore	The maximum score value

Returns: ENIGMA_SUCCESS on success, ENIGMA_FAILURE on failure

◆ enigma_crack_set_min_score()

int enigma_crack_set_min_score	(	EnigmaCrackParams *	cfg,
		float	minScore
	)

Set the minimum score field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance
minScore	The minimum score value

Returns: ENIGMA_SUCCESS on success, ENIGMA_FAILURE on failure

◆ enigma_crack_set_n()

int enigma_crack_set_n	(	EnigmaCrackParams *	cfg,
		int	n
	)

Set the n field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance
n	The n value

Returns: ENIGMA_SUCCESS on success, ENIGMA_FAILURE on failure

◆ enigma_crack_set_ngrams()

int enigma_crack_set_ngrams	(	EnigmaCrackParams *	cfg,
		float *	ngrams,
		int	n,
		size_t	length
	)

Set the ngrams field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance
ngrams	The ngrams array
n	The n value
length	The length of the ngrams array

Returns: ENIGMA_SUCCESS on success, ENIGMA_FAILURE on failure

◆ enigma_crack_set_score_list()

int enigma_crack_set_score_list	(	EnigmaCrackParams *	cfg,
		EnigmaScoreList *	scoreList
	)

Set the score_list field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance
scoreList	The EnigmaScoreList instance

Returns: ENIGMA_SUCCESS on success, ENIGMA_FAILURE on failure

◆ enigma_crack_set_target_score()

int enigma_crack_set_target_score	(	EnigmaCrackParams *	cfg,
		float	targetScore
	)

Set the target score field in the given EnigmaCrackParams struct.

Parameters

cfg	The EnigmaCrackParams struct instance
targetScore	The target score value

Returns: ENIGMA_SUCCESS on success, ENIGMA_FAILURE on failure

◆ enigma_dict_match()

int enigma_dict_match	(	const EnigmaCrackParams *	cfg,
		const char *	plaintext
	)

Checks if multiple words from the dictionary are present in the plaintext.

This function checks the plaintext against a dictionary of words and returns 1 if multiple words are found, otherwise returns 0.

The dictionary must be uppercase and sorted.

Parameters

cfg	The EnigmaCrackParams struct containing the dictionary and its size
plaintext	The plaintext to check

Returns: 1 if multiple words are found, 0 if not, ENIGMA_FAILURE on error

◆ enigma_find_potential_indices()

int enigma_find_potential_indices	(	const char *	ciphertext,
		const char *	plaintext,
		int *	indices
	)

Finds potential indices in the ciphertext where the known plaintext may exist.

Due to the nature of the Enigma machine, a letter cannot be encoded to itself. This function checks the ciphertext for potential indices where the given string could potentially be in the plaintext.

Parameters

ciphertext	The ciphertext to analyze
plaintext	The known plaintext string to test against the ciphertext
indices	Pointer to an array (length >= length of ciphertext) to store the indices (-1-terminated)

Returns: ENIGMA_SUCCESS on success, ENIGMA_FAILURE on failure.

◆ enigma_freq()

float enigma_freq	(	const char *	plaintext,
		int	len
	)

Calculate the frequency of characters in the plaintext.

This function calculates the frequency of each character in the plaintext and returns a score based on the frequencies.

Parameters

plaintext	The plaintext to analyze
len	The length of the plaintext

Returns: The frequency score of the plaintext, or ENIGMA_FAILURE if the input is invalid.

◆ enigma_letter_freq()

int enigma_letter_freq	(	const EnigmaCrackParams *	cfg,
		const char *	plaintext
	)

Check if the letter frequencies in the plaintext match target frequencies within an offset.

This function checks if the frequency of each letter in the plaintext is within the specified offset of the target frequencies. If more than ten letters deviate from the target frequencies, the function returns 0 (false). Otherwise, it returns 1 (true).

Parameters

cfg	The EnigmaCrackParams struct containing the target frequencies and offset
plaintext	The plaintext to analyze

Returns: 1 if over half of the letter frequencies match within the offset, 0 if not, ENIGMA_FAILURE if error.

◆ enigma_score_append()

int enigma_score_append	(	EnigmaCrackParams *	cfg,
		Enigma *	enigma,
		const char *	plaintext,
		float	score
	)

Append a score to an EnigmaScoreList.

If the scores array is full, it will be resized to double its current size.

Parameters

cfg	Pointer to the cracking configuration structure.
enigma	Pointer to the Enigma structure representing the scored configuration.
plaintext	The plaintext corresponding to the score.
score	The score to append.

Returns: ENIGMA_SUCCESS on success, ENIGMA_FAILURE on failure.

◆ enigma_score_flags()

int enigma_score_flags	(	const EnigmaCrackParams *	cfg,
		const char *	plaintext
	)

Get the flags for a given plaintext based on the crack configuration.

This function checks the plaintext against the criteria specified in the EnigmaCrackParams and returns a bitmask of flags indicating which criteria were met.

Parameters

cfg	The EnigmaCrackParams containing the criteria and flags.
plaintext	The plaintext to evaluate.

Returns: A bitmask of flags indicating which criteria were met, or ENIGMA_FAILURE if error.

Data Structures

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ ENIGMA_CIPHERTEXT_EXISTS

◆ ENIGMA_DICTIONARY_EXISTS

◆ ENIGMA_FLAG_X_SEPARATED

◆ ENIGMA_IOC_FREQS_EXIST

◆ ENIGMA_N_GRAMS_EXIST

◆ ENIGMA_PLUGBOARD_DEFINED

◆ ENIGMA_REFLECTOR_DEFINED

◆ ENIGMA_ROTOR_POSITIONS_DEFINED

◆ ENIGMA_ROTORS_DEFINED

◆ ENIGMA_SCORE_BOUNDS_EXIST

Function Documentation

◆ enigma_crack_get_ciphertext()

◆ enigma_crack_get_ciphertext_length()

◆ enigma_crack_get_dictionary()

◆ enigma_crack_get_dictionary_length()

◆ enigma_crack_get_enigma()

◆ enigma_crack_get_flags()

◆ enigma_crack_get_frequency_targets()

◆ enigma_crack_get_known_plaintext()

◆ enigma_crack_get_known_plaintext_length()

◆ enigma_crack_get_max_score()

◆ enigma_crack_get_min_score()

◆ enigma_crack_get_n()

◆ enigma_crack_get_ngrams()

◆ enigma_crack_get_ngrams_length()

◆ enigma_crack_get_score_list()

◆ enigma_crack_get_target_score()

◆ enigma_crack_params_new()

◆ enigma_crack_params_validate()

◆ enigma_crack_plugboard()

◆ enigma_crack_reflector()

◆ enigma_crack_rotor()

◆ enigma_crack_rotor_position()

◆ enigma_crack_rotor_positions()

◆ enigma_crack_rotors()

◆ enigma_crack_set_ciphertext()

◆ enigma_crack_set_dictionary()

◆ enigma_crack_set_enigma()

◆ enigma_crack_set_flags()

◆ enigma_crack_set_frequency_targets()

◆ enigma_crack_set_known_plaintext()

◆ enigma_crack_set_max_score()

◆ enigma_crack_set_min_score()

◆ enigma_crack_set_n()

◆ enigma_crack_set_ngrams()

◆ enigma_crack_set_score_list()

◆ enigma_crack_set_target_score()

◆ enigma_dict_match()

◆ enigma_find_potential_indices()

◆ enigma_freq()

◆ enigma_letter_freq()

◆ enigma_score_append()

◆ enigma_score_flags()