rippled
Loading...
Searching...
No Matches
Sign.h
1//------------------------------------------------------------------------------
2/*
3 This file is part of rippled: https://github.com/ripple/rippled
4 Copyright (c) 2012, 2013 Ripple Labs Inc.
5
6 Permission to use, copy, modify, and/or distribute this software for any
7 purpose with or without fee is hereby granted, provided that the above
8 copyright notice and this permission notice appear in all copies.
9
10 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17*/
18//==============================================================================
19
20#ifndef RIPPLE_PROTOCOL_SIGN_H_INCLUDED
21#define RIPPLE_PROTOCOL_SIGN_H_INCLUDED
22
23#include <xrpl/protocol/HashPrefix.h>
24#include <xrpl/protocol/PublicKey.h>
25#include <xrpl/protocol/STObject.h>
26#include <xrpl/protocol/SecretKey.h>
27#include <utility>
28
29namespace ripple {
30
42void
43sign(
44 STObject& st,
45 HashPrefix const& prefix,
46 KeyType type,
47 SecretKey const& sk,
48 SF_VL const& sigField = sfSignature);
49
58bool
59verify(
60 STObject const& st,
61 HashPrefix const& prefix,
62 PublicKey const& pk,
63 SF_VL const& sigField = sfSignature);
64
66Serializer
67buildMultiSigningData(STObject const& obj, AccountID const& signingID);
68
81Serializer
82startMultiSigningData(STObject const& obj);
83
84inline void
86{
87 s.addBitString(signingID);
88}
89
90} // namespace ripple
91
92#endif
int addBitString(base_uint< Bits, Tag > const &v)
Definition: Serializer.h:131
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition: algorithm.h:26
base_uint< 160, detail::AccountIDTag > AccountID
A 160-bit unsigned that uniquely identifies an account.
Definition: AccountID.h:49
TypedField< STBlob > SF_VL
Definition: SField.h:361
void finishMultiSigningData(AccountID const &signingID, Serializer &s)
Definition: Sign.h:85
Serializer startMultiSigningData(STObject const &obj)
Break the multi-signing hash computation into 2 parts for optimization.
Definition: Sign.cpp:95
bool verify(PublicKey const &publicKey, Slice const &m, Slice const &sig, bool mustBeFullyCanonical=true) noexcept
Verify a signature on a message.
Definition: PublicKey.cpp:272
Serializer buildMultiSigningData(STObject const &obj, AccountID const &signingID)
Return a Serializer suitable for computing a multisigning TxnSignature.
Definition: Sign.cpp:87
Buffer sign(PublicKey const &pk, SecretKey const &sk, Slice const &message)
Generate a signature for a message.
Definition: SecretKey.cpp:238
KeyType
Definition: KeyType.h:28
HashPrefix
Prefix for hashing functions.
Definition: HashPrefix.h:54