Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
sudo-project
GitHub Repository: sudo-project/sudo
 Path: blob/main/plugins/sudoers/auth/sudo_auth.h
1532 views
1
/*

2
 * SPDX-License-Identifier: ISC

3
 *

4
 * Copyright (c) 1999-2005, 2007-2016, 2018 Todd C. Miller <[email protected]>

5
 *

6
 * Permission to use, copy, modify, and 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
#ifndef SUDO_AUTH_H

20
#define SUDO_AUTH_H

21


22
/* Private auth function return values (rowhammer resistant).  */

23
#define AUTH_INTR		0x69d61fc8	/* 1101001110101100001111111001000 */

24
#define AUTH_NONINTERACTIVE	0x1629e037	/* 0010110001010011110000000110111 */

25


26
struct sudoers_context;

27
typedef struct sudo_auth {

28
    unsigned int flags;		/* various flags, see below */

29
    int status;			/* status from verify routine */

30
    const char *name;		/* name of the method as a string */

31
    void *data;			/* method-specific data pointer */

32
    int (*init)(const struct sudoers_context *ctx, struct passwd *pw, struct sudo_auth *auth);

33
    int (*setup)(const struct sudoers_context *ctx, struct passwd *pw, char **prompt, struct sudo_auth *auth);

34
    int (*verify)(const struct sudoers_context *ctx, struct passwd *pw, const char *p, struct sudo_auth *auth, struct sudo_conv_callback *callback);

35
    int (*approval)(const struct sudoers_context *ctx, struct passwd *pw, struct sudo_auth *auth, bool exempt);

36
    int (*cleanup)(const struct sudoers_context *ctx, struct passwd *pw, struct sudo_auth *auth, bool force);

37
    int (*begin_session)(const struct sudoers_context *ctx, struct passwd *pw, char **user_env[], struct sudo_auth *auth);

38
    int (*end_session)(struct sudo_auth *auth);

39
} sudo_auth;

40


41
/* Values for sudo_auth.flags.  */

42
#define FLAG_DISABLED		0x02U	/* method disabled */

43
#define FLAG_STANDALONE		0x04U	/* standalone auth method */

44
#define FLAG_ONEANDONLY		0x08U	/* one and only auth method */

45
#define FLAG_NONINTERACTIVE	0x10U	/* no user input allowed */

46


47
/* Shortcuts for using the flags above. */

48
#define IS_DISABLED(x)		((x)->flags & FLAG_DISABLED)

49
#define IS_STANDALONE(x)	((x)->flags & FLAG_STANDALONE)

50
#define IS_ONEANDONLY(x)	((x)->flags & FLAG_ONEANDONLY)

51
#define IS_NONINTERACTIVE(x)	((x)->flags & FLAG_NONINTERACTIVE)

52


53
/* Like tgetpass() but uses conversation function */

54
char *auth_getpass(const char *prompt, int type, struct sudo_conv_callback *callback);

55


56
/* Pointer to conversation function to use with auth_getpass(). */

57
extern sudo_conv_t sudo_conv;

58


59
/* Prototypes for standalone methods */

60
int bsdauth_init(const struct sudoers_context *ctx, struct passwd *pw, sudo_auth *auth);

61
int bsdauth_verify(const struct sudoers_context *ctx, struct passwd *pw, const char *prompt, sudo_auth *auth, struct sudo_conv_callback *callback);

62
int bsdauth_approval(const struct sudoers_context *ctx, struct passwd *pw, sudo_auth *auth, bool exempt);

63
int bsdauth_cleanup(const struct sudoers_context *ctx, struct passwd *pw, sudo_auth *auth, bool force);

64
void bsdauth_set_style(const char *style);

65
int sudo_aix_init(const struct sudoers_context *ctx, struct passwd *pw, sudo_auth *auth);

66
int sudo_aix_verify(const struct sudoers_context *ctx, struct passwd *pw, const char *pass, sudo_auth *auth, struct sudo_conv_callback *callback);

67
int sudo_aix_cleanup(const struct sudoers_context *ctx, struct passwd *pw, sudo_auth *auth, bool force);

68
int sudo_pam_init(const struct sudoers_context *ctx, struct passwd *pw, sudo_auth *auth);

69
int sudo_pam_init_quiet(const struct sudoers_context *ctx, struct passwd *pw, sudo_auth *auth);

70
int sudo_pam_verify(const struct sudoers_context *ctx, struct passwd *pw, const char *prompt, sudo_auth *auth, struct sudo_conv_callback *callback);

71
int sudo_pam_approval(const struct sudoers_context *ctx, struct passwd *pw, sudo_auth *auth, bool exempt);

72
int sudo_pam_cleanup(const struct sudoers_context *ctx, struct passwd *pw, sudo_auth *auth, bool force);

73
int sudo_pam_begin_session(const struct sudoers_context *ctx, struct passwd *pw, char **user_env[], sudo_auth *auth);

74
int sudo_pam_end_session(sudo_auth *auth);

75
int sudo_securid_init(const struct sudoers_context *ctx, struct passwd *pw, sudo_auth *auth);

76
int sudo_securid_setup(const struct sudoers_context *ctx, struct passwd *pw, char **prompt, sudo_auth *auth);

77
int sudo_securid_verify(const struct sudoers_context *ctx, struct passwd *pw, const char *pass, sudo_auth *auth, struct sudo_conv_callback *callback);

78
int sudo_sia_setup(const struct sudoers_context *ctx, struct passwd *pw, char **prompt, sudo_auth *auth);

79
int sudo_sia_verify(const struct sudoers_context *ctx, struct passwd *pw, const char *prompt, sudo_auth *auth, struct sudo_conv_callback *callback);

80
int sudo_sia_cleanup(const struct sudoers_context *ctx, struct passwd *pw, sudo_auth *auth, bool force);

81
int sudo_sia_begin_session(const struct sudoers_context *ctx, struct passwd *pw, char **user_env[], sudo_auth *auth);

82


83
/* Prototypes for normal methods */

84
int sudo_afs_verify(const struct sudoers_context *ctx, struct passwd *pw, const char *pass, sudo_auth *auth, struct sudo_conv_callback *callback);

85
int sudo_dce_verify(const struct sudoers_context *ctx, struct passwd *pw, const char *pass, sudo_auth *auth, struct sudo_conv_callback *callback);

86
int sudo_krb5_init(const struct sudoers_context *ctx, struct passwd *pw, sudo_auth *auth);

87
int sudo_krb5_setup(const struct sudoers_context *ctx, struct passwd *pw, char **prompt, sudo_auth *auth);

88
int sudo_krb5_verify(const struct sudoers_context *ctx, struct passwd *pw, const char *pass, sudo_auth *auth, struct sudo_conv_callback *callback);

89
int sudo_krb5_cleanup(const struct sudoers_context *ctx, struct passwd *pw, sudo_auth *auth, bool force);

90
int sudo_passwd_init(const struct sudoers_context *ctx, struct passwd *pw, sudo_auth *auth);

91
int sudo_passwd_verify(const struct sudoers_context *ctx, struct passwd *pw, const char *pass, sudo_auth *auth, struct sudo_conv_callback *callback);

92
int sudo_passwd_cleanup(const struct sudoers_context *ctx, struct passwd *pw, sudo_auth *auth, bool force);

93
int sudo_rfc1938_setup(const struct sudoers_context *ctx, struct passwd *pw, char **prompt, sudo_auth *auth);

94
int sudo_rfc1938_verify(const struct sudoers_context *ctx, struct passwd *pw, const char *pass, sudo_auth *auth, struct sudo_conv_callback *callback);

95
int sudo_secureware_init(const struct sudoers_context *ctx, struct passwd *pw, sudo_auth *auth);

96
int sudo_secureware_verify(const struct sudoers_context *ctx, struct passwd *pw, const char *pass, sudo_auth *auth, struct sudo_conv_callback *callback);

97
int sudo_secureware_cleanup(const struct sudoers_context *ctx, struct passwd *pw, sudo_auth *auth, bool force);

98


99
/* Fields: name, flags, init, setup, verify, approval, cleanup, begin_sess, end_sess */

100
#define AUTH_ENTRY(n, f, i, s, v, a, c, b, e) \

101
	{ (f), AUTH_FAILURE, (n), NULL, (i), (s), (v), (a), (c) , (b), (e) },

102


103
#endif /* SUDO_AUTH_H */

104


105