/share/man/man9/VFS_CHECKEXP.9

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 88 lines · 88 code · 0 blank · 0 comment · 0 complexity · 6e28f16f24f40eb8874a3bc104dbe5ad MD5 · raw file 

    

  1. .\"
    2. 

  2. .\" Copyright (c) 1999 Alfred Perlstein
    3. 

  3. .\"
    4. 

  4. .\" All rights reserved.
    5. 

  5. .\"
    6. 

  6. .\" This program is free software.
    7. 

  7. .\"
    8. 

  8. .\" Redistribution and use in source and binary forms, with or without
    9. 

  9. .\" modification, are permitted provided that the following condition
    10. 

  10. .\" is met:
    11. 

  11. .\"    Redistributions of source code must retain the above copyright
    12. 

  12. .\"    notice, this condition and the following disclaimer.
    13. 

  13. .\"
    14. 

  14. .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
    15. 

  15. .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    16. 

  16. .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
    17. 

  17. .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
    18. 

  18. .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    19. 

  19. .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    20. 

  20. .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    21. 

  21. .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    22. 

  22. .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    23. 

  23. .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    24. 

  24. .\"
    25. 

  25. .\" $FreeBSD$
    26. 

  26. .\"
    27. 

  27. .Dd January 4, 2010
    28. 

  28. .Dt VFS_CHECKEXP 9
    29. 

  29. .Os
    30. 

  30. .Sh NAME
    31. 

  31. .Nm VFS_CHECKEXP
    32. 

  32. .Nd check if a file system is exported to a client
    33. 

  33. .Sh SYNOPSIS
    34. 

  34. .In sys/param.h
    35. 

  35. .In sys/mount.h
    36. 

  36. .Ft int
    37. 

  37. .Fn VFS_CHECKEXP "struct mount *mp" "struct sockaddr *nam" "int *exflagsp" "struct ucred **credanonp"
    38. 

  38. .Sh DESCRIPTION
    39. 

  39. The
    40. 

  40. .Fn VFS_CHECKEXP
    41. 

  41. macro is used by the NFS server to check if a mount point is exported
    42. 

  42. to a client.
    43. 

  43. .Pp
    44. 

  44. The arguments it expects are:
    45. 

  45. .Bl -tag -width credanonp
    46. 

  46. .It Fa mp
    47. 

  47. The mount point to be checked.
    48. 

  48. .It Fa nam
    49. 

  49. An mbuf containing the network address of the client.
    50. 

  50. .It Fa exflagsp
    51. 

  51. Return parameter for the export flags for this client.
    52. 

  52. .It Fa credanonp
    53. 

  53. Return parameter for the anonymous credentials for this client.
    54. 

  54. .El
    55. 

  55. .Pp
    56. 

  56. The
    57. 

  57. .Fn VFS_CHECKEXP
    58. 

  58. macro should be called on a file system's mount structure to determine if it
    59. 

  59. is exported to a client whose address is contained in
    60. 

  60. .Fa nam .
    61. 

  61. .Pp
    62. 

  62. It is generally called before
    63. 

  63. .Xr VFS_FHTOVP 9
    64. 

  64. to validate that a client has access to the file system.
    65. 

  65. .Pp
    66. 

  66. The file system should call
    67. 

  67. .Xr vfs_export_lookup 9
    68. 

  68. with the address of an appropriate
    69. 

  69. .Vt netexport
    70. 

  70. structure and the address of the client,
    71. 

  71. .Fa nam ,
    72. 

  72. to verify that the client can access this file system.
    73. 

  73. .Sh RETURN VALUES
    74. 

  74. The export flags and anonymous credentials specific to the client (returned
    75. 

  75. by
    76. 

  76. .Xr vfs_export_lookup 9 )
    77. 

  77. will be returned in
    78. 

  78. .Fa *exflagsp
    79. 

  79. and
    80. 

  80. .Fa *credanonp .
    81. 

  81. .Sh SEE ALSO
    82. 

  82. .Xr VFS 9 ,
    83. 

  83. .Xr VFS_FHTOVP 9 ,
    84. 

  84. .Xr VOP_VPTOFH 9 ,
    85. 

  85. .Xr vnode 9
    86. 

  86. .Sh AUTHORS
    87. 

  87. This manual page was written by
    88. 

  88. .An Alfred Perlstein .
    89.