rippled
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 <ripple/protocol/HashPrefix.h>
24 #include <ripple/protocol/PublicKey.h>
25 #include <ripple/protocol/SecretKey.h>
26 #include <ripple/protocol/STObject.h>
27 #include <utility>
28 
29 namespace ripple {
30 
42 void
43 sign (STObject& st, HashPrefix const& prefix,
44  KeyType type, SecretKey const& sk,
45  SF_Blob const& sigField = sfSignature);
46 
55 bool
56 verify (STObject const& st, HashPrefix const& prefix,
57  PublicKey const& pk,
58  SF_Blob const& sigField = sfSignature);
59 
61 Serializer
62 buildMultiSigningData (STObject const& obj, AccountID const& signingID);
63 
76 Serializer
77 startMultiSigningData (STObject const& obj);
78 
79 inline void
81 {
82  s.add160 (signingID);
83 }
84 
85 } // ripple
86 
87 #endif
utility
ripple::AccountID
base_uint< 160, detail::AccountIDTag > AccountID
A 160-bit unsigned that uniquely identifies an account.
Definition: AccountID.h:48
ripple::sfSignature
const SF_Blob sfSignature(access, STI_VL, 6, "Signature", SField::sMD_Default, SField::notSigning)
Definition: SField.h:444
ripple::finishMultiSigningData
void finishMultiSigningData(AccountID const &signingID, Serializer &s)
Definition: Sign.h:80
ripple::SF_Blob
TypedField< STBlob > SF_Blob
Definition: SField.h:311
ripple::verify
bool verify(PublicKey const &publicKey, Slice const &m, Slice const &sig, bool mustBeFullyCanonical)
Verify a signature on a message.
Definition: PublicKey.cpp:277
ripple::base_uint
Definition: base_uint.h:65
ripple::HashPrefix
HashPrefix
Prefix for hashing functions.
Definition: HashPrefix.h:56
ripple::startMultiSigningData
Serializer startMultiSigningData(STObject const &obj)
Break the multi-signing hash computation into 2 parts for optimization.
Definition: Sign.cpp:91
ripple::KeyType
KeyType
Definition: KeyType.h:28
ripple::Serializer
Definition: Serializer.h:43
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition: RCLCensorshipDetector.h:29
ripple::sign
Buffer sign(PublicKey const &pk, SecretKey const &sk, Slice const &m)
Generate a signature for a message.
Definition: SecretKey.cpp:132
ripple::Serializer::add160
int add160(base_uint< 160, Tag > const &i)
Definition: Serializer.h:105
ripple::buildMultiSigningData
Serializer buildMultiSigningData(STObject const &obj, AccountID const &signingID)
Return a Serializer suitable for computing a multisigning TxnSignature.
Definition: Sign.cpp:83