160 lines
5.1 KiB
C
160 lines
5.1 KiB
C
//==============================================================================
|
|
// This file is part of Master Password.
|
|
// Copyright (c) 2011-2017, Maarten Billemont.
|
|
//
|
|
// Master Password is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Master Password is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You can find a copy of the GNU General Public License in the
|
|
// LICENSE file. Alternatively, see <http://www.gnu.org/licenses/>.
|
|
//==============================================================================
|
|
|
|
#ifndef _MPW_MARSHALL_H
|
|
#define _MPW_MARSHALL_H
|
|
|
|
#include <time.h>
|
|
|
|
#include "mpw-algorithm.h"
|
|
|
|
//// Types.
|
|
|
|
typedef mpw_enum( unsigned int, MPMarshalFormat ) {
|
|
/** Generate a key for authentication. */
|
|
MPMarshalFormatNone,
|
|
/** Generate a key for authentication. */
|
|
MPMarshalFormatFlat,
|
|
/** Generate a name for identification. */
|
|
MPMarshalFormatJSON,
|
|
|
|
#if MPW_JSON
|
|
MPMarshalFormatDefault = MPMarshalFormatJSON,
|
|
#else
|
|
MPMarshalFormatDefault = MPMarshalFormatFlat,
|
|
#endif
|
|
};
|
|
|
|
typedef mpw_enum( unsigned int, MPMarshalErrorType ) {
|
|
/** The marshalling operation completed successfully. */
|
|
MPMarshalSuccess,
|
|
/** An error in the structure of the marshall file interrupted marshalling. */
|
|
MPMarshalErrorStructure,
|
|
/** The marshall file uses an unsupported format version. */
|
|
MPMarshalErrorFormat,
|
|
/** A required value is missing or not specified. */
|
|
MPMarshalErrorMissing,
|
|
/** The given master password is not valid. */
|
|
MPMarshalErrorMasterPassword,
|
|
/** An illegal value was specified. */
|
|
MPMarshalErrorIllegal,
|
|
/** An internal system error interrupted marshalling. */
|
|
MPMarshalErrorInternal,
|
|
};
|
|
typedef struct MPMarshalError {
|
|
MPMarshalErrorType type;
|
|
const char *description;
|
|
} MPMarshalError;
|
|
|
|
typedef struct MPMarshalledQuestion {
|
|
const char *keyword;
|
|
const char *content;
|
|
MPResultType type;
|
|
} MPMarshalledQuestion;
|
|
|
|
typedef struct MPMarshalledSite {
|
|
const char *name;
|
|
const char *content;
|
|
MPResultType type;
|
|
MPCounterValue counter;
|
|
MPAlgorithmVersion algorithm;
|
|
|
|
const char *loginContent;
|
|
MPResultType loginType;
|
|
|
|
const char *url;
|
|
unsigned int uses;
|
|
time_t lastUsed;
|
|
|
|
size_t questions_count;
|
|
MPMarshalledQuestion *questions;
|
|
} MPMarshalledSite;
|
|
|
|
typedef struct MPMarshalledUser {
|
|
const char *fullName;
|
|
const char *masterPassword;
|
|
MPAlgorithmVersion algorithm;
|
|
bool redacted;
|
|
|
|
unsigned int avatar;
|
|
MPResultType defaultType;
|
|
time_t lastUsed;
|
|
|
|
size_t sites_count;
|
|
MPMarshalledSite *sites;
|
|
} MPMarshalledUser;
|
|
|
|
typedef struct MPMarshalInfo {
|
|
MPMarshalFormat format;
|
|
MPAlgorithmVersion algorithm;
|
|
const char *fullName;
|
|
const char *keyID;
|
|
bool redacted;
|
|
time_t date;
|
|
} MPMarshalInfo;
|
|
|
|
//// Marshalling.
|
|
|
|
/** Write the user and all associated data out to the given output buffer using the given marshalling format. */
|
|
bool mpw_marshall_write(
|
|
char **out, const MPMarshalFormat outFormat, const MPMarshalledUser *user, MPMarshalError *error);
|
|
/** Try to read metadata on the sites in the input buffer. */
|
|
MPMarshalInfo *mpw_marshall_read_info(
|
|
const char *in);
|
|
/** Unmarshall sites in the given input buffer by parsing it using the given marshalling format. */
|
|
MPMarshalledUser *mpw_marshall_read(
|
|
const char *in, const MPMarshalFormat inFormat, const char *masterPassword, MPMarshalError *error);
|
|
|
|
//// Utilities.
|
|
|
|
/** Create a new user object ready for marshalling. */
|
|
MPMarshalledUser *mpw_marshall_user(
|
|
const char *fullName, const char *masterPassword, const MPAlgorithmVersion algorithmVersion);
|
|
/** Create a new site attached to the given user object, ready for marshalling. */
|
|
MPMarshalledSite *mpw_marshall_site(
|
|
MPMarshalledUser *user,
|
|
const char *siteName, const MPResultType resultType, const MPCounterValue siteCounter, const MPAlgorithmVersion algorithmVersion);
|
|
/** Create a new question attached to the given site object, ready for marshalling. */
|
|
MPMarshalledQuestion *mpw_marshal_question(
|
|
MPMarshalledSite *site, const char *keyword);
|
|
/** Free the given user object and all associated data. */
|
|
bool mpw_marshal_info_free(
|
|
MPMarshalInfo **info);
|
|
bool mpw_marshal_free(
|
|
MPMarshalledUser **user);
|
|
|
|
//// Format.
|
|
|
|
/**
|
|
* @return The purpose represented by the given name.
|
|
*/
|
|
const MPMarshalFormat mpw_formatWithName(
|
|
const char *formatName);
|
|
/**
|
|
* @return The standard name for the given purpose.
|
|
*/
|
|
const char *mpw_nameForFormat(
|
|
const MPMarshalFormat format);
|
|
/**
|
|
* @return The file extension that's recommended for files that use the given marshalling format.
|
|
*/
|
|
const char *mpw_marshall_format_extension(
|
|
const MPMarshalFormat format);
|
|
|
|
#endif // _MPW_MARSHALL_H
|