~rdoering/ubuntu/karmic/erlang/fix-535090

« back to all changes in this revision

Viewing changes to lib/orber/doc/src/orber_acl.xml

• browse files at revision 3.1.2
• compare with another revision
• download diff
• download tarball
• view history from revision 3.1.2

Show diffs side-by-side

added

removed

lib/orber/doc/src/orber_acl.xml

 

1

<?xml version="1.0" encoding="latin1" ?>

 

2

<!DOCTYPE erlref SYSTEM "erlref.dtd">

 

3

 

 

4

<erlref>

 

5

  <header>

 

6

    <copyright>

 

7

      <year>2005</year>

 

8

      <year>2007</year>

 

9

      <holder>Ericsson AB, All Rights Reserved</holder>

 

10

    </copyright>

 

11

    <legalnotice>

 

12

  The contents of this file are subject to the Erlang Public License,

 

13

  Version 1.1, (the "License"); you may not use this file except in

 

14

  compliance with the License. You should have received a copy of the

 

15

  Erlang Public License along with this software. If not, it can be

 

16

  retrieved online at http://www.erlang.org/.

 

17

 

 

18

  Software distributed under the License is distributed on an "AS IS"

 

19

  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See

 

20

  the License for the specific language governing rights and limitations

 

21

  under the License.

 

22

 

 

23

  The Initial Developer of the Original Code is Ericsson AB.

 

24

    </legalnotice>

 

25

 

 

26

    <title>orber_acl</title>

 

27

    <prepared></prepared>

 

28

    <responsible></responsible>

 

29

    <docno></docno>

 

30

    <approved></approved>

 

31

    <checked></checked>

 

32

    <date>2005-05-19</date>

 

33

    <rev>A</rev>

 

34

  </header>

 

35

  <module>orber_acl</module>

 

36

  <modulesummary>Orber ACL operations</modulesummary>

 

37

  <description>

 

38

    <p>This module contains functions intended for analyzing Access 

 

39

      Control List (ACL) filters. The filters uses a extended format of 

 

40

      Classless Inter Domain Routing (CIDR). 

 

41

      For example, <c>"123.123.123.10"</c> limits

 

42

      the connection to that particular host, while <c>"123.123.123.10/17"</c> allows

 

43

      connections to or from any host equal to the 17 most significant bits. Orber

 

44

      also allow the user to specify a certain port or port range, for example,

 

45

      <c>"123.123.123.10/17#4001"</c> and <c>"123.123.123.10/17#4001/5001"</c>

 

46

      respectively. IPv4 or none compressed IPv6 strings are accepted.</p>

 

47

  </description>

 

48

  <funcs>

 

49

    <func>

 

50

      <name>match(IP, Direction) -> boolean()</name>

 

51

      <name>match(IP, Direction, GetInfo) -> Reply</name>

 

52

      <fsummary>Verify if the IP address versus the current configuration</fsummary>

 

53

      <type>

 

54

        <v>IP = tuple() | [integer()]</v>

 

55

        <v>Direction = tcp_in | ssl_in | tcp_out | ssl_out</v>

 

56

        <v>GetInfo = boolean()</v>

 

57

        <v>Reply = boolean() | {boolean(), [Interface], PortInfo}</v>

 

58

        <v>Interface = string()</v>

 

59

        <v>PortInfo = integer() | {integer(), integer()}</v>

 

60

      </type>

 

61

      <desc>

 

62

        <p>If <c>GetInfo</c> is not supplied or set to false, this operation returns

 

63

          a boolean which tells if the IPv4 or IPv6 address would pass the ACL

 

64

          filter, defined by the <c>iiop_acl</c> configuration parameter, or not.

 

65

          When <c>GetInfo</c> is set to true, a tuple which, besides the boolean

 

66

          that tells if access was granted, also include the defined

 

67

          interfaces and port(s). This operation requires that Orber is running and

 

68

          can be used on a live node to determine if Orber has been properly configured.</p>

 

69

      </desc>

 

70

    </func>

 

71

    <func>

 

72

      <name>verify(IP, Filter, Family) -> Reply</name>

 

73

      <fsummary>Verify if the IP address versus the Filter</fsummary>

 

74

      <type>

 

75

        <v>IP = string()</v>

 

76

        <v>Filter = string()</v>

 

77

        <v>Family = inet | inet6</v>

 

78

        <v>Reply = true | {false, From, To} | {error, string()}</v>

 

79

        <v>From = string()</v>

 

80

        <v>To = string()</v>

 

81

      </type>

 

82

      <desc>

 

83

        <p>This operation returns true if the IPv4 or IPv6 address would pass the

 

84

          supplied ACL. If that is not the case, a tuple containing the accepted range

 

85

          is returned. This operation should only be used for test purposes.</p>

 

86

      </desc>

 

87

    </func>

 

88

    <func>

 

89

      <name>range(Filter, Family) -> Reply</name>

 

90

      <fsummary>Get range of Filter</fsummary>

 

91

      <type>

 

92

        <v>Filter = string()</v>

 

93

        <v>Family = inet | inet6</v>

 

94

        <v>Reply = {ok, From, To} | {error, string()}</v>

 

95

        <v>From = string()</v>

 

96

        <v>To = string()</v>

 

97

      </type>

 

98

      <desc>

 

99

        <p>Returns the range of accepted IP addresses based on the supplied filter. 

 

100

          This operation should only be used for test purposes.</p>

 

101

      </desc>

 

102

    </func>

 

103

  </funcs>

 

104

  

 

105

</erlref>

 

106

 

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1