mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-12-27 09:04:40 +01:00
88 lines
2.8 KiB
C
88 lines
2.8 KiB
C
#ifndef LIGHTNING_COMMON_ONION_H
|
|
#define LIGHTNING_COMMON_ONION_H
|
|
#include "config.h"
|
|
#include <bitcoin/privkey.h>
|
|
#include <common/amount.h>
|
|
|
|
struct route_step;
|
|
|
|
enum onion_payload_type {
|
|
ONION_V0_PAYLOAD = 0,
|
|
ONION_TLV_PAYLOAD = 1,
|
|
};
|
|
|
|
struct onion_payload {
|
|
enum onion_payload_type type;
|
|
|
|
struct amount_msat amt_to_forward;
|
|
u32 outgoing_cltv;
|
|
struct amount_msat *total_msat;
|
|
struct short_channel_id *forward_channel;
|
|
struct secret *payment_secret;
|
|
u8 *payment_metadata;
|
|
|
|
/* If blinding is set, blinding_ss is the shared secret.*/
|
|
struct pubkey *blinding;
|
|
struct secret blinding_ss;
|
|
|
|
/* The raw TLVs contained in the payload. */
|
|
struct tlv_tlv_payload *tlv;
|
|
};
|
|
|
|
u8 *onion_nonfinal_hop(const tal_t *ctx,
|
|
const struct short_channel_id *scid,
|
|
struct amount_msat forward,
|
|
u32 outgoing_cltv,
|
|
const struct pubkey *blinding,
|
|
const u8 *enctlv);
|
|
|
|
/* Note that this can fail if we supply payment_secret or payment_metadata and !use_tlv! */
|
|
u8 *onion_final_hop(const tal_t *ctx,
|
|
struct amount_msat forward,
|
|
u32 outgoing_cltv,
|
|
struct amount_msat total_msat,
|
|
const struct pubkey *blinding,
|
|
const u8 *enctlv,
|
|
const struct secret *payment_secret,
|
|
const u8 *payment_metadata);
|
|
|
|
/**
|
|
* onion_payload_length: measure payload length in decrypted onion.
|
|
* @raw_payload: payload to look at.
|
|
* @len: length of @raw_payload in bytes.
|
|
* @has_realm: used for HTLCs, where first byte 0 is magical.
|
|
* @valid: set to true if it is valid, false otherwise.
|
|
* @type: if non-NULL, set to type of payload if *@valid is true.
|
|
*
|
|
* If @valid is set, there is room for the HMAC immediately following,
|
|
* as the return value is <= ROUTING_INFO_SIZE - HMAC_SIZE. Otherwise,
|
|
* the return value is @len (i.e. the entire payload).
|
|
*/
|
|
size_t onion_payload_length(const u8 *raw_payload, size_t len,
|
|
bool has_realm,
|
|
bool *valid,
|
|
enum onion_payload_type *type);
|
|
|
|
/**
|
|
* onion_decode: decode payload from a decrypted onion.
|
|
* @ctx: context to allocate onion_contents off.
|
|
* @rs: the route_step, whose raw_payload is of at least length
|
|
* onion_payload_length().
|
|
* @blinding: the optional incoming blinding point.
|
|
* @blinding_ss: the shared secret derived from @blinding (iff that's non-NULL)
|
|
* @accepted_extra_tlvs: Allow these types to be in the TLV without failing
|
|
* @failtlvtype: (out) the tlv type which failed to parse.
|
|
* @failtlvpos: (out) the offset in the tlv which failed to parse.
|
|
*
|
|
* If the payload is not valid, returns NULL.
|
|
*/
|
|
struct onion_payload *onion_decode(const tal_t *ctx,
|
|
const struct route_step *rs,
|
|
const struct pubkey *blinding,
|
|
const struct secret *blinding_ss,
|
|
const u64 *accepted_extra_tlvs,
|
|
u64 *failtlvtype,
|
|
size_t *failtlvpos);
|
|
|
|
#endif /* LIGHTNING_COMMON_ONION_H */
|