af_rxrpc.h

  1/* SPDX-License-Identifier: GPL-2.0-or-later */
  2/* RxRPC kernel service interface definitions
  3 *
  4 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
  5 * Written by David Howells (dhowells@redhat.com)
  6 */
  7
  8#ifndef _NET_RXRPC_H
  9#define _NET_RXRPC_H
 10
 11#include <linux/rxrpc.h>
 12#include <linux/ktime.h>
 13
 14struct key;
 15struct sock;
 16struct socket;
 17struct rxrpc_call;
 18struct rxrpc_peer;
 19struct krb5_buffer;
 20enum rxrpc_abort_reason;
 21
 22enum rxrpc_interruptibility {
 23	RXRPC_INTERRUPTIBLE,	/* Call is interruptible */
 24	RXRPC_PREINTERRUPTIBLE,	/* Call can be cancelled whilst waiting for a slot */
 25	RXRPC_UNINTERRUPTIBLE,	/* Call should not be interruptible at all */
 26};
 27
 28enum rxrpc_oob_type {
 29	RXRPC_OOB_CHALLENGE,	/* Security challenge for a connection */
 30};
 31
 32/*
 33 * Debug ID counter for tracing.
 34 */
 35extern atomic_t rxrpc_debug_id;
 36
 37/*
 38 * Operations table for rxrpc to call out to a kernel application (e.g. kAFS).
 39 */
 40struct rxrpc_kernel_ops {
 41	void (*notify_new_call)(struct sock *sk, struct rxrpc_call *call,
 42				unsigned long user_call_ID);
 43	void (*discard_new_call)(struct rxrpc_call *call, unsigned long user_call_ID);
 44	void (*user_attach_call)(struct rxrpc_call *call, unsigned long user_call_ID);
 45	void (*notify_oob)(struct sock *sk, struct sk_buff *oob);
 46};
 47
 48typedef void (*rxrpc_notify_rx_t)(struct sock *, struct rxrpc_call *,
 49				  unsigned long);
 50typedef void (*rxrpc_notify_end_tx_t)(struct sock *, struct rxrpc_call *,
 51				      unsigned long);
 52
 53void rxrpc_kernel_set_notifications(struct socket *sock,
 54				    const struct rxrpc_kernel_ops *app_ops);
 55struct rxrpc_call *rxrpc_kernel_begin_call(struct socket *sock,
 56					   struct rxrpc_peer *peer,
 57					   struct key *key,
 58					   unsigned long user_call_ID,
 59					   s64 tx_total_len,
 60					   u32 hard_timeout,
 61					   gfp_t gfp,
 62					   rxrpc_notify_rx_t notify_rx,
 63					   u16 service_id,
 64					   bool upgrade,
 65					   enum rxrpc_interruptibility interruptibility,
 66					   unsigned int debug_id);
 67int rxrpc_kernel_send_data(struct socket *, struct rxrpc_call *,
 68			   struct msghdr *, size_t,
 69			   rxrpc_notify_end_tx_t);
 70int rxrpc_kernel_recv_data(struct socket *, struct rxrpc_call *,
 71			   struct iov_iter *, size_t *, bool, u32 *, u16 *);
 72bool rxrpc_kernel_abort_call(struct socket *, struct rxrpc_call *,
 73			     u32, int, enum rxrpc_abort_reason);
 74void rxrpc_kernel_shutdown_call(struct socket *sock, struct rxrpc_call *call);
 75void rxrpc_kernel_put_call(struct socket *sock, struct rxrpc_call *call);
 76struct rxrpc_peer *rxrpc_kernel_lookup_peer(struct socket *sock,
 77					    struct sockaddr_rxrpc *srx, gfp_t gfp);
 78void rxrpc_kernel_put_peer(struct rxrpc_peer *peer);
 79struct rxrpc_peer *rxrpc_kernel_get_peer(struct rxrpc_peer *peer);
 80struct rxrpc_peer *rxrpc_kernel_get_call_peer(struct socket *sock, struct rxrpc_call *call);
 81const struct sockaddr_rxrpc *rxrpc_kernel_remote_srx(const struct rxrpc_peer *peer);
 82const struct sockaddr *rxrpc_kernel_remote_addr(const struct rxrpc_peer *peer);
 83unsigned long rxrpc_kernel_set_peer_data(struct rxrpc_peer *peer, unsigned long app_data);
 84unsigned long rxrpc_kernel_get_peer_data(const struct rxrpc_peer *peer);
 85unsigned int rxrpc_kernel_get_srtt(const struct rxrpc_peer *);
 86int rxrpc_kernel_charge_accept(struct socket *sock, rxrpc_notify_rx_t notify_rx,
 87			       unsigned long user_call_ID, gfp_t gfp,
 88			       unsigned int debug_id);
 89void rxrpc_kernel_set_tx_length(struct socket *, struct rxrpc_call *, s64);
 90bool rxrpc_kernel_check_life(const struct socket *, const struct rxrpc_call *);
 91
 92int rxrpc_sock_set_min_security_level(struct sock *sk, unsigned int val);
 93int rxrpc_sock_set_security_keyring(struct sock *, struct key *);
 94int rxrpc_sock_set_manage_response(struct sock *sk, bool set);
 95
 96enum rxrpc_oob_type rxrpc_kernel_query_oob(struct sk_buff *oob,
 97					   struct rxrpc_peer **_peer,
 98					   unsigned long *_peer_appdata);
 99struct sk_buff *rxrpc_kernel_dequeue_oob(struct socket *sock,
100					 enum rxrpc_oob_type *_type);
101void rxrpc_kernel_free_oob(struct sk_buff *oob);
102void rxrpc_kernel_query_challenge(struct sk_buff *challenge,
103				  struct rxrpc_peer **_peer,
104				  unsigned long *_peer_appdata,
105				  u16 *_service_id, u8 *_security_index);
106int rxrpc_kernel_reject_challenge(struct sk_buff *challenge, u32 abort_code,
107				  int error, enum rxrpc_abort_reason why);
108int rxkad_kernel_respond_to_challenge(struct sk_buff *challenge);
109u32 rxgk_kernel_query_challenge(struct sk_buff *challenge);
110int rxgk_kernel_respond_to_challenge(struct sk_buff *challenge,
111				     struct krb5_buffer *appdata);
112u8 rxrpc_kernel_query_call_security(struct rxrpc_call *call,
113				    u16 *_service_id, u32 *_enctype);
114
115#endif /* _NET_RXRPC_H */