1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277
|
<pre>Internet Engineering Task Force (IETF) L. Bertz, Ed.
Request for Comments: 8506 Sprint
Obsoletes: <a href="./rfc4006">4006</a> D. Dolson, Ed.
Category: Standards Track Y. Lifshitz, Ed.
ISSN: 2070-1721 Sandvine
March 2019
<span class="h1">Diameter Credit-Control Application</span>
Abstract
This document specifies a Diameter application that can be used to
implement real-time credit-control for a variety of end-user services
such as network access, Session Initiation Protocol (SIP) services,
messaging services, and download services. The Diameter Credit-
Control application as defined in this document obsoletes <a href="./rfc4006">RFC 4006</a>,
and it must be supported by all new Diameter Credit-Control
application implementations.
Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by the
Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in <a href="./rfc7841#section-2">Section 2 of RFC 7841</a>.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
<a href="https://www.rfc-editor.org/info/rfc8506">https://www.rfc-editor.org/info/rfc8506</a>.
<span class="grey">Bertz, et al. Standards Track [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Copyright Notice
Copyright (c) 2019 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
Provisions Relating to IETF Documents
(<a href="https://trustee.ietf.org/license-info">https://trustee.ietf.org/license-info</a>) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
This document may contain material from IETF Documents or IETF
Contributions published or made publicly available before November
10, 2008. The person(s) controlling the copyright in some of this
material may not have granted the IETF Trust the right to allow
modifications of such material outside the IETF Standards Process.
Without obtaining an adequate license from the person(s) controlling
the copyright in such materials, this document may not be modified
outside the IETF Standards Process, and derivative works of it may
not be created outside the IETF Standards Process, except to format
it for publication as an RFC or to translate it into languages other
than English.
<span class="grey">Bertz, et al. Standards Track [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Table of Contents
<a href="#section-1">1</a>. Introduction ....................................................<a href="#page-6">6</a>
<a href="#section-1.1">1.1</a>. Requirements Language ......................................<a href="#page-7">7</a>
<a href="#section-1.2">1.2</a>. Terminology ................................................<a href="#page-7">7</a>
<a href="#section-1.3">1.3</a>. Advertising Application Support ............................<a href="#page-9">9</a>
<a href="#section-2">2</a>. Architecture Models .............................................<a href="#page-9">9</a>
<a href="#section-3">3</a>. Credit-Control Messages ........................................<a href="#page-11">11</a>
<a href="#section-3.1">3.1</a>. Credit-Control-Request (CCR) Command ......................<a href="#page-11">11</a>
<a href="#section-3.2">3.2</a>. Credit-Control-Answer (CCA) Command .......................<a href="#page-12">12</a>
<a href="#section-4">4</a>. Credit-Control Application Overview ............................<a href="#page-13">13</a>
<a href="#section-4.1">4.1</a>. Service-Specific Rating Input and Interoperability ........<a href="#page-14">14</a>
<a href="#section-4.1.1">4.1.1</a>. Specifying Rating Input AVPs .......................<a href="#page-15">15</a>
<a href="#section-4.1.2">4.1.2</a>. Service-Specific Documentation .....................<a href="#page-16">16</a>
<a href="#section-4.1.3">4.1.3</a>. Handling of Unsupported/Incorrect Rating Input .....<a href="#page-16">16</a>
<a href="#section-4.1.4">4.1.4</a>. RADIUS Vendor-Specific Rating Attributes ...........<a href="#page-17">17</a>
<a href="#section-5">5</a>. Session-Based Credit-Control ...................................<a href="#page-17">17</a>
<a href="#section-5.1">5.1</a>. General Principles ........................................<a href="#page-17">17</a>
<a href="#section-5.1.1">5.1.1</a>. Basic Support for Tariff Time Change ...............<a href="#page-18">18</a>
5.1.2. Credit-Control for Multiple Services within
a (Sub-)Session ....................................<a href="#page-19">19</a>
<a href="#section-5.2">5.2</a>. First Interrogation .......................................<a href="#page-23">23</a>
5.2.1. First Interrogation after Authorization and
Authentication .....................................<a href="#page-25">25</a>
5.2.2. First Interrogation Included with
Authorization Messages .............................<a href="#page-27">27</a>
<a href="#section-5.3">5.3</a>. Intermediate Interrogation ................................<a href="#page-29">29</a>
<a href="#section-5.4">5.4</a>. Final Interrogation .......................................<a href="#page-31">31</a>
<a href="#section-5.5">5.5</a>. Server-Initiated Credit Re-authorization ..................<a href="#page-32">32</a>
<a href="#section-5.6">5.6</a>. Graceful Service Termination ..............................<a href="#page-34">34</a>
<a href="#section-5.6.1">5.6.1</a>. Terminate Action ...................................<a href="#page-37">37</a>
<a href="#section-5.6.2">5.6.2</a>. Redirect Action ....................................<a href="#page-38">38</a>
<a href="#section-5.6.3">5.6.3</a>. Restrict Access Action .............................<a href="#page-40">40</a>
5.6.4. Usage of the Server-Initiated Credit
Re-authorization ...................................<a href="#page-41">41</a>
<a href="#section-5.7">5.7</a>. Failure Procedures ........................................<a href="#page-41">41</a>
<a href="#section-6">6</a>. One-Time Event .................................................<a href="#page-44">44</a>
<a href="#section-6.1">6.1</a>. Service Price Inquiry .....................................<a href="#page-45">45</a>
<a href="#section-6.2">6.2</a>. Balance Checks ............................................<a href="#page-46">46</a>
<a href="#section-6.3">6.3</a>. Direct Debiting ...........................................<a href="#page-46">46</a>
<a href="#section-6.4">6.4</a>. Refunds ...................................................<a href="#page-47">47</a>
<a href="#section-6.5">6.5</a>. Failure Procedure .........................................<a href="#page-48">48</a>
<a href="#section-7">7</a>. Credit-Control Application State Machines ......................<a href="#page-50">50</a>
<a href="#section-8">8</a>. Credit-Control AVPs ............................................<a href="#page-59">59</a>
<a href="#section-8.1">8.1</a>. CC-Correlation-Id AVP .....................................<a href="#page-61">61</a>
<a href="#section-8.2">8.2</a>. CC-Request-Number AVP .....................................<a href="#page-62">62</a>
<a href="#section-8.3">8.3</a>. CC-Request-Type AVP .......................................<a href="#page-62">62</a>
<a href="#section-8.4">8.4</a>. CC-Session-Failover AVP ...................................<a href="#page-63">63</a>
<span class="grey">Bertz, et al. Standards Track [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<a href="#section-8.5">8.5</a>. CC-Sub-Session-Id AVP .....................................<a href="#page-64">64</a>
<a href="#section-8.6">8.6</a>. Check-Balance-Result AVP ..................................<a href="#page-64">64</a>
<a href="#section-8.7">8.7</a>. Cost-Information AVP ......................................<a href="#page-64">64</a>
<a href="#section-8.8">8.8</a>. Unit-Value AVP ............................................<a href="#page-65">65</a>
<a href="#section-8.9">8.9</a>. Exponent AVP ..............................................<a href="#page-65">65</a>
<a href="#section-8.10">8.10</a>. Value-Digits AVP .........................................<a href="#page-66">66</a>
<a href="#section-8.11">8.11</a>. Currency-Code AVP ........................................<a href="#page-66">66</a>
<a href="#section-8.12">8.12</a>. Cost-Unit AVP ............................................<a href="#page-66">66</a>
<a href="#section-8.13">8.13</a>. Credit-Control AVP .......................................<a href="#page-66">66</a>
<a href="#section-8.14">8.14</a>. Credit-Control-Failure-Handling AVP (CCFH) ...............<a href="#page-67">67</a>
<a href="#section-8.15">8.15</a>. Direct-Debiting-Failure-Handling AVP (DDFH) ..............<a href="#page-68">68</a>
<a href="#section-8.16">8.16</a>. Multiple-Services-Credit-Control AVP .....................<a href="#page-68">68</a>
<a href="#section-8.17">8.17</a>. Granted-Service-Unit AVP .................................<a href="#page-70">70</a>
<a href="#section-8.18">8.18</a>. Requested-Service-Unit AVP ...............................<a href="#page-71">71</a>
<a href="#section-8.19">8.19</a>. Used-Service-Unit AVP ....................................<a href="#page-71">71</a>
<a href="#section-8.20">8.20</a>. Tariff-Time-Change AVP ...................................<a href="#page-72">72</a>
<a href="#section-8.21">8.21</a>. CC-Time AVP ..............................................<a href="#page-72">72</a>
<a href="#section-8.22">8.22</a>. CC-Money AVP .............................................<a href="#page-72">72</a>
<a href="#section-8.23">8.23</a>. CC-Total-Octets AVP ......................................<a href="#page-72">72</a>
<a href="#section-8.24">8.24</a>. CC-Input-Octets AVP ......................................<a href="#page-72">72</a>
<a href="#section-8.25">8.25</a>. CC-Output-Octets AVP .....................................<a href="#page-73">73</a>
<a href="#section-8.26">8.26</a>. CC-Service-Specific-Units AVP ............................<a href="#page-73">73</a>
<a href="#section-8.27">8.27</a>. Tariff-Change-Usage AVP ..................................<a href="#page-73">73</a>
<a href="#section-8.28">8.28</a>. Service-Identifier AVP ...................................<a href="#page-74">74</a>
<a href="#section-8.29">8.29</a>. Rating-Group AVP .........................................<a href="#page-74">74</a>
<a href="#section-8.30">8.30</a>. G-S-U-Pool-Reference AVP .................................<a href="#page-74">74</a>
<a href="#section-8.31">8.31</a>. G-S-U-Pool-Identifier AVP ................................<a href="#page-75">75</a>
<a href="#section-8.32">8.32</a>. CC-Unit-Type AVP .........................................<a href="#page-75">75</a>
<a href="#section-8.33">8.33</a>. Validity-Time AVP ........................................<a href="#page-75">75</a>
<a href="#section-8.34">8.34</a>. Final-Unit-Indication AVP ................................<a href="#page-76">76</a>
<a href="#section-8.35">8.35</a>. Final-Unit-Action AVP ....................................<a href="#page-77">77</a>
<a href="#section-8.36">8.36</a>. Restriction-Filter-Rule AVP ..............................<a href="#page-78">78</a>
<a href="#section-8.37">8.37</a>. Redirect-Server AVP ......................................<a href="#page-78">78</a>
<a href="#section-8.38">8.38</a>. Redirect-Address-Type AVP ................................<a href="#page-79">79</a>
<a href="#section-8.39">8.39</a>. Redirect-Server-Address AVP ..............................<a href="#page-79">79</a>
<a href="#section-8.40">8.40</a>. Multiple-Services-Indicator AVP ..........................<a href="#page-80">80</a>
<a href="#section-8.41">8.41</a>. Requested-Action AVP .....................................<a href="#page-80">80</a>
<a href="#section-8.42">8.42</a>. Service-Context-Id AVP ...................................<a href="#page-81">81</a>
<a href="#section-8.43">8.43</a>. Service-Parameter-Info AVP ...............................<a href="#page-82">82</a>
<a href="#section-8.44">8.44</a>. Service-Parameter-Type AVP ...............................<a href="#page-82">82</a>
<a href="#section-8.45">8.45</a>. Service-Parameter-Value AVP ..............................<a href="#page-83">83</a>
<a href="#section-8.46">8.46</a>. Subscription-Id AVP ......................................<a href="#page-83">83</a>
<a href="#section-8.47">8.47</a>. Subscription-Id-Type AVP .................................<a href="#page-83">83</a>
<a href="#section-8.48">8.48</a>. Subscription-Id-Data AVP .................................<a href="#page-84">84</a>
<a href="#section-8.49">8.49</a>. User-Equipment-Info AVP ..................................<a href="#page-84">84</a>
<a href="#section-8.50">8.50</a>. User-Equipment-Info-Type AVP .............................<a href="#page-84">84</a>
<a href="#section-8.51">8.51</a>. User-Equipment-Info-Value AVP ............................<a href="#page-85">85</a>
<a href="#section-8.52">8.52</a>. User-Equipment-Info-Extension AVP ........................<a href="#page-85">85</a>
<span class="grey">Bertz, et al. Standards Track [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<a href="#section-8.53">8.53</a>. User-Equipment-Info-IMEISV AVP ...........................<a href="#page-86">86</a>
<a href="#section-8.54">8.54</a>. User-Equipment-Info-MAC AVP ..............................<a href="#page-86">86</a>
<a href="#section-8.55">8.55</a>. User-Equipment-Info-EUI64 AVP ............................<a href="#page-86">86</a>
<a href="#section-8.56">8.56</a>. User-Equipment-Info-ModifiedEUI64 AVP ....................<a href="#page-86">86</a>
<a href="#section-8.57">8.57</a>. User-Equipment-Info-IMEI AVP .............................<a href="#page-86">86</a>
<a href="#section-8.58">8.58</a>. Subscription-Id-Extension AVP ............................<a href="#page-87">87</a>
<a href="#section-8.59">8.59</a>. Subscription-Id-E164 AVP .................................<a href="#page-87">87</a>
<a href="#section-8.60">8.60</a>. Subscription-Id-IMSI AVP .................................<a href="#page-87">87</a>
<a href="#section-8.61">8.61</a>. Subscription-Id-SIP-URI AVP ..............................<a href="#page-88">88</a>
<a href="#section-8.62">8.62</a>. Subscription-Id-NAI AVP ..................................<a href="#page-88">88</a>
<a href="#section-8.63">8.63</a>. Subscription-Id-Private AVP ..............................<a href="#page-88">88</a>
<a href="#section-8.64">8.64</a>. Redirect-Server-Extension AVP ............................<a href="#page-88">88</a>
<a href="#section-8.65">8.65</a>. Redirect-Address-IPAddress AVP ...........................<a href="#page-89">89</a>
<a href="#section-8.66">8.66</a>. Redirect-Address-URL AVP .................................<a href="#page-89">89</a>
<a href="#section-8.67">8.67</a>. Redirect-Address-SIP-URI AVP .............................<a href="#page-89">89</a>
<a href="#section-8.68">8.68</a>. QoS-Final-Unit-Indication AVP ............................<a href="#page-89">89</a>
<a href="#section-9">9</a>. Result-Code AVP Values .........................................<a href="#page-91">91</a>
<a href="#section-9.1">9.1</a>. Transient Failures ........................................<a href="#page-91">91</a>
<a href="#section-9.2">9.2</a>. Permanent Failures ........................................<a href="#page-92">92</a>
<a href="#section-10">10</a>. AVP Occurrence Table ..........................................<a href="#page-92">92</a>
<a href="#section-10.1">10.1</a>. Credit-Control AVP Table .................................<a href="#page-93">93</a>
<a href="#section-10.2">10.2</a>. Re-Auth-Request/Re-Auth-Answer AVP Table .................<a href="#page-94">94</a>
<a href="#section-11">11</a>. RADIUS/Diameter Credit-Control Interworking Model .............<a href="#page-94">94</a>
<a href="#section-12">12</a>. IANA Considerations ...........................................<a href="#page-97">97</a>
<a href="#section-12.1">12.1</a>. Application Identifier ...................................<a href="#page-97">97</a>
<a href="#section-12.2">12.2</a>. Command Codes ............................................<a href="#page-97">97</a>
<a href="#section-12.3">12.3</a>. AVP Codes ................................................<a href="#page-97">97</a>
<a href="#section-12.4">12.4</a>. Result-Code AVP Values ...................................<a href="#page-98">98</a>
<a href="#section-12.5">12.5</a>. CC-Request-Type AVP ......................................<a href="#page-98">98</a>
<a href="#section-12.6">12.6</a>. CC-Session-Failover AVP ..................................<a href="#page-98">98</a>
<a href="#section-12.7">12.7</a>. CC-Unit-Type AVP .........................................<a href="#page-99">99</a>
<a href="#section-12.8">12.8</a>. Check-Balance-Result AVP .................................<a href="#page-99">99</a>
<a href="#section-12.9">12.9</a>. Credit-Control AVP .......................................<a href="#page-99">99</a>
<a href="#section-12.10">12.10</a>. Credit-Control-Failure-Handling AVP .....................<a href="#page-99">99</a>
<a href="#section-12.11">12.11</a>. Direct-Debiting-Failure-Handling AVP ....................<a href="#page-99">99</a>
<a href="#section-12.12">12.12</a>. Final-Unit-Action AVP ...................................<a href="#page-99">99</a>
<a href="#section-12.13">12.13</a>. Multiple-Services-Indicator AVP ........................<a href="#page-100">100</a>
<a href="#section-12.14">12.14</a>. Redirect-Address-Type AVP ..............................<a href="#page-100">100</a>
<a href="#section-12.15">12.15</a>. Requested-Action AVP ...................................<a href="#page-100">100</a>
<a href="#section-12.16">12.16</a>. Subscription-Id-Type AVP ...............................<a href="#page-100">100</a>
<a href="#section-12.17">12.17</a>. Tariff-Change-Usage AVP ................................<a href="#page-100">100</a>
<a href="#section-12.18">12.18</a>. User-Equipment-Info-Type AVP ...........................<a href="#page-100">100</a>
<a href="#section-13">13</a>. Parameters Related to the Credit-Control Application .........<a href="#page-101">101</a>
<a href="#section-14">14</a>. Security Considerations ......................................<a href="#page-101">101</a>
<a href="#section-14.1">14.1</a>. Direct Connection with Redirects ........................<a href="#page-102">102</a>
<a href="#section-14.2">14.2</a>. Application-Level Redirects .............................<a href="#page-103">103</a>
<span class="grey">Bertz, et al. Standards Track [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<a href="#section-15">15</a>. Privacy Considerations .......................................<a href="#page-104">104</a>
<a href="#section-15.1">15.1</a>. Privacy-Sensitive AVPs ..................................<a href="#page-104">104</a>
<a href="#section-15.2">15.2</a>. Data Minimization .......................................<a href="#page-106">106</a>
<a href="#section-15.3">15.3</a>. Diameter Agents .........................................<a href="#page-107">107</a>
<a href="#section-16">16</a>. References ...................................................<a href="#page-107">107</a>
<a href="#section-16.1">16.1</a>. Normative References ....................................<a href="#page-107">107</a>
<a href="#section-16.2">16.2</a>. Informative References ..................................<a href="#page-110">110</a>
<a href="#appendix-A">Appendix A</a>. Credit-Control Sequences .............................<a href="#page-111">111</a>
<a href="#appendix-A.1">A.1</a>. Flow I ....................................................<a href="#page-111">111</a>
<a href="#appendix-A.2">A.2</a>. Flow II ...................................................<a href="#page-113">113</a>
<a href="#appendix-A.3">A.3</a>. Flow III ..................................................<a href="#page-116">116</a>
<a href="#appendix-A.4">A.4</a>. Flow IV ...................................................<a href="#page-117">117</a>
<a href="#appendix-A.5">A.5</a>. Flow V ....................................................<a href="#page-119">119</a>
<a href="#appendix-A.6">A.6</a>. Flow VI ...................................................<a href="#page-120">120</a>
<a href="#appendix-A.7">A.7</a>. Flow VII ..................................................<a href="#page-121">121</a>
<a href="#appendix-A.8">A.8</a>. Flow VIII .................................................<a href="#page-123">123</a>
<a href="#appendix-A.9">A.9</a>. Flow IX ...................................................<a href="#page-124">124</a>
Acknowledgements .................................................<a href="#page-130">130</a>
Authors' Addresses ...............................................<a href="#page-130">130</a>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
This document specifies a Diameter application that can be used to
implement real-time credit-control for a variety of end-user services
such as network access, Session Initiation Protocol (SIP) services,
messaging services, and download services. ("Credit-control" is
sometimes abbreviated as "CC" in figures and tables throughout this
document.) The Diameter Credit-Control application as defined in
this document obsoletes [<a href="./rfc4006" title=""Diameter Credit-Control Application"">RFC4006</a>], and it must be supported by all
new Diameter Credit-Control application implementations. This
document provides a general solution to real-time cost and
credit-control.
The prepaid model has been shown to be very successful -- for
instance, in GSM networks, where network operators offering prepaid
services have experienced a substantial growth of their customer base
and revenues. Prepaid services are now cropping up in many other
wireless and wire-line-based networks.
In mobile networks, additional functionality is required beyond that
specified in the Diameter base protocol [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]. For example, the
3GPP charging and billing requirements document [<a href="#ref-TGPPCHARG">TGPPCHARG</a>] states
that an application must be able to rate service information in
real time. In addition, it is necessary to check that the end user's
account provides coverage for the requested service prior to
initiation of that service. When an account is exhausted or expired,
the user must be denied the ability to compile additional chargeable
events.
<span class="grey">Bertz, et al. Standards Track [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
A mechanism has to be provided to allow the user to be informed of
the charges to be levied for a requested service. In addition, there
are services such as gaming and advertising that may credit as well
as debit a user account.
The other Diameter applications provide service-specific
authorization, and they do not provide credit authorization for
prepaid users. The credit authorization shall be generic and
applicable to all the service environments required to support
prepaid services.
To fulfill these requirements, it is necessary to facilitate
credit-control communication between the network element providing
the service (e.g., Network Access Server (NAS), SIP Proxy,
Application Server) and a credit-control server.
The scope of this specification is credit authorization. Service-
specific authorization and authentication are out of scope.
<span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>. Requirements Language</span>
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in
<a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a> [<a href="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>] [<a href="./rfc8174" title=""Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words"">RFC8174</a>] when, and only when, they appear in all
capitals, as shown here.
<span class="h3"><a class="selflink" id="section-1.2" href="#section-1.2">1.2</a>. Terminology</span>
AAA: Authentication, Authorization, and Accounting.
AA-Answer: "AA-Answer" generically refers to a service-specific
authorization and authentication answer. AA-Answer commands are
defined in service-specific authorization applications, e.g.,
[<a href="./rfc7155" title=""Diameter Network Access Server Application"">RFC7155</a>] [<a href="./rfc4004" title=""Diameter Mobile IPv4 Application"">RFC4004</a>].
AA-Request: "AA-Request" generically refers to a service-specific
authorization and authentication request. AA-Request commands are
defined in service-specific authorization applications, e.g.,
[<a href="./rfc7155" title=""Diameter Network Access Server Application"">RFC7155</a>] [<a href="./rfc4004" title=""Diameter Mobile IPv4 Application"">RFC4004</a>].
Credit-control: "Credit-control" is a mechanism that directly
interacts in real time with an account and controls or monitors
the charges related to service usage. Credit-control is a
process of (1) checking whether or not credit is available,
(2) credit reservation, (3) deduction of credit from the end-user
account when service is completed, and (4) refunding of reserved
credit that is not used.
<span class="grey">Bertz, et al. Standards Track [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Diameter Credit-Control server: A Diameter Credit-Control server
acts as a prepaid server, performing real-time rating and
credit-control. It is located in the home domain and is accessed
by Service Elements or Diameter AAA servers in real time, for the
purpose of price determination and credit-control before the
service event is delivered to the end user. It may also interact
with Business Support Systems.
Diameter Credit-Control client: A Diameter Credit-Control client is
an entity that interacts with a credit-control server. It
monitors the usage of the granted quota according to instructions
returned by the credit-control server.
Interrogation: The Diameter Credit-Control client uses interrogation
to initiate a session-based credit-control process. During the
credit-control process, it is used to report the used quota and
request a new one. An interrogation maps to a request/answer
transaction.
One-time event: A charging transaction session comprising a single
request and single response.
Rating: The act of determining the cost of the service event.
Service: A type of task performed by a Service Element for an
end user.
Service Element: A network element that provides a service to the
end users. The Service Element may include the Diameter
Credit-Control client or another entity (e.g., a RADIUS AAA
server) that can act as a credit-control client on behalf of the
Service Element. In the latter case, the interface between the
Service Element and the Diameter Credit-Control client is outside
the scope of this specification. Examples of Service Elements
include NASs, SIP Proxies, and Application Servers such as
messaging servers, content servers, and gaming servers.
Service event: An event relating to a service provided to the
end user.
Session-based credit-control: A credit-control process that makes
use of several interrogations: the first, a possible intermediate,
and the final. The first interrogation is used to reserve money
from the user's account and to initiate the process. Intermediate
interrogations (if any) may be needed to request a new quota while
the service is being rendered. The final interrogation is used to
exit the process. The credit-control server is required to
maintain session state for session-based credit-control.
<span class="grey">Bertz, et al. Standards Track [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-1.3" href="#section-1.3">1.3</a>. Advertising Application Support</span>
Diameter nodes conforming to this specification MUST advertise
support by including the value of 4 in the Auth-Application-Id of the
Capabilities-Exchange-Request and Capabilities-Exchange-Answer
commands [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>].
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Architecture Models</span>
The current accounting models specified in the RADIUS accounting and
Diameter base specifications [<a href="./rfc2866" title=""RADIUS Accounting"">RFC2866</a>] [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>] are not sufficient
for real-time credit-control, where creditworthiness is to be
determined prior to service initiation. Also, the existing Diameter
authorization applications [<a href="./rfc7155" title=""Diameter Network Access Server Application"">RFC7155</a>] [<a href="./rfc4004" title=""Diameter Mobile IPv4 Application"">RFC4004</a>] only provide service
authorization; they do not provide credit authorization for prepaid
users. In order to support real-time credit-control, a new type of
server is needed in the AAA infrastructure: the Diameter
Credit-Control server. The Diameter Credit-Control server is the
entity responsible for credit authorization for prepaid subscribers.
A Service Element may authenticate and authorize the end user with
the AAA server by using AAA protocols, e.g., RADIUS or the Diameter
base protocol (possibly extended via a Diameter application).
Accounting protocols such as RADIUS accounting and the Diameter base
accounting protocol can be used to provide accounting data to the
accounting server after service is initiated and to provide possible
interim reports until service completion. However, for real-time
credit-control, these authorization and accounting models are not
sufficient.
When real-time credit-control is required, the credit-control client
contacts the credit-control server with information about a possible
service event. The credit-control process is performed to determine
potential charges and to verify whether the end user's account
balance is sufficient to cover the cost of the service being
rendered.
Figure 1 illustrates the typical credit-control architecture, which
consists of a Service Element with an embedded Diameter
Credit-Control client, a Diameter Credit-Control server, and a AAA
server. A Business Support System is usually deployed; at a minimum,
it includes billing functionality. The credit-control server and AAA
server in this architecture model are logical entities. The real
configuration can combine them into a single host. The
credit-control protocol is the Diameter base protocol [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>] with
the Diameter Credit-Control application.
<span class="grey">Bertz, et al. Standards Track [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
When an end user requests services such as SIP or messaging, the
request is typically forwarded to a Service Element (e.g., a SIP
Proxy) in the user's home realm as defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]. In some
cases, it might be possible that the Service Element in the local
realm [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>] can offer services to the end user; however, a
commercial agreement must exist between the local realm and the home
realm. Network access is an example of a service offered in the
local realm where the NAS, through a AAA infrastructure,
authenticates and authorizes the user with the user's home network.
Service Element AAA and CC
+----------+ +---------+ Protocols+-----------+ +--------+
| End |<---->|+-------+|<------------>| AAA | |Business|
| User | +->|| CC || | Server |->|Support |
| | | || Client||<-----+ | | |System |
+----------+ | |+-------+| | +-----------+ | |
| +---------+ | ^ +--------+
+----------+ | | CC Protocol | ^
| End |<--+ | +-----v----+ |
| User | +------>|Credit- | |
+----------+ Credit-Control |Control |--------+
Protocol |Server |
+----------+
Figure 1: Typical Credit-Control Architecture
There can be multiple credit-control servers in the system for
redundancy and load balancing. The system can also contain separate
rating server(s), and accounts can be located in a centralized
database. To ensure that the end user's account is not debited or
credited multiple times for the same service event, only one entity
in the credit-control system should perform duplicate detection.
System-internal interfaces can exist to relay messages between
servers and an account manager. However, the detailed architecture
of the credit-control system and its interfaces is implementation
specific and is out of scope for this specification.
Protocol-transparent Diameter relays can exist between the
credit-control client and credit-control server. Also, Diameter
redirect agents that refer credit-control clients to credit-control
servers and allow them to communicate directly can exist. These
agents transparently support the Diameter Credit-Control application.
The different roles of Diameter agents are defined in Diameter base
<a href="./rfc6733#section-2.8">[RFC6733], Section 2.8</a>.
If Diameter Credit-Control proxies exist between the credit-control
client and the credit-control server, they MUST advertise support for
the Diameter Credit-Control application.
<span class="grey">Bertz, et al. Standards Track [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Credit-Control Messages</span>
This section defines new Diameter message Command Code values that
MUST be supported by all Diameter implementations that conform to
this specification. The Command Codes are as follows:
+------------------------+---------+------+-------------+
| Command Name | Abbrev. | Code | Reference |
+------------------------+---------+------+-------------+
| Credit-Control-Request | CCR | 272 | <a href="#section-3.1">Section 3.1</a> |
| Credit-Control-Answer | CCA | 272 | <a href="#section-3.2">Section 3.2</a> |
+------------------------+---------+------+-------------+
Table 1: Credit-Control Commands
<a href="./rfc6733#section-3.2">Section 3.2 of [RFC6733]</a> (Diameter base) defines the Command Code
Format specification. These formats are observed in credit-control
messages.
<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. Credit-Control-Request (CCR) Command</span>
The Credit-Control-Request message (CCR) is indicated by the Command
Code field being set to 272 and the 'R' bit being set in the Command
Flags field. It is used between the Diameter Credit-Control client
and the credit-control server to request credit authorization for a
given service.
The Auth-Application-Id MUST be set to the value 4, indicating the
Diameter Credit-Control application.
The CCR is extensible via the inclusion of one or more
Attribute-Value Pairs (AVPs).
Message Format:
<Credit-Control-Request> ::= < Diameter Header: 272, REQ, PXY >
< Session-Id >
{ Origin-Host }
{ Origin-Realm }
{ Destination-Realm }
{ Auth-Application-Id }
{ Service-Context-Id }
{ CC-Request-Type }
{ CC-Request-Number }
[ Destination-Host ]
[ User-Name ]
[ CC-Sub-Session-Id ]
[ Acct-Multi-Session-Id ]
<span class="grey">Bertz, et al. Standards Track [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
[ Origin-State-Id ]
[ Event-Timestamp ]
*[ Subscription-Id ]
*[ Subscription-Id-Extension ]
[ Service-Identifier ]
[ Termination-Cause ]
[ Requested-Service-Unit ]
[ Requested-Action ]
*[ Used-Service-Unit ]
[ Multiple-Services-Indicator ]
*[ Multiple-Services-Credit-Control ]
*[ Service-Parameter-Info ]
[ CC-Correlation-Id ]
[ User-Equipment-Info ]
[ User-Equipment-Info-Extension ]
*[ Proxy-Info ]
*[ Route-Record ]
*[ AVP ]
<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. Credit-Control-Answer (CCA) Command</span>
The Credit-Control-Answer message (CCA) is indicated by the Command
Code field being set to 272 and the 'R' bit being cleared in the
Command Flags field. It is used between the credit-control server
and the Diameter Credit-Control client to acknowledge a
Credit-Control-Request command.
Message Format:
<Credit-Control-Answer> ::= < Diameter Header: 272, PXY >
< Session-Id >
{ Result-Code }
{ Origin-Host }
{ Origin-Realm }
{ Auth-Application-Id }
{ CC-Request-Type }
{ CC-Request-Number }
[ User-Name ]
[ CC-Session-Failover ]
[ CC-Sub-Session-Id ]
[ Acct-Multi-Session-Id ]
[ Origin-State-Id ]
[ Event-Timestamp ]
[ Granted-Service-Unit ]
*[ Multiple-Services-Credit-Control ]
[ Cost-Information ]
[ Final-Unit-Indication ]
[ QoS-Final-Unit-Indication ]
<span class="grey">Bertz, et al. Standards Track [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
[ Check-Balance-Result ]
[ Credit-Control-Failure-Handling ]
[ Direct-Debiting-Failure-Handling ]
[ Validity-Time ]
*[ Redirect-Host ]
[ Redirect-Host-Usage ]
[ Redirect-Max-Cache-Time ]
*[ Proxy-Info ]
*[ Route-Record ]
*[ Failed-AVP ]
*[ AVP ]
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Credit-Control Application Overview</span>
The credit authorization process takes place before and during
service delivery to the end user and generally requires the user's
authentication and authorization before any requests are sent to the
credit-control server. The credit-control application defined in
this specification supports two different credit authorization
models: credit authorization with money reservation and credit
authorization with direct debiting. In both models, the
credit-control client requests credit authorization from the
credit-control server prior to allowing any services to be delivered
to the end user.
In the first model, the credit-control server rates the request,
reserves a suitable amount of money from the user's account, and
returns the amount of credit reserved. Note that credit resources
may not imply actual monetary credit; credit resources may be granted
to the credit-control client in the form of units (e.g., data volume
or time) to be metered.
Upon receipt of a successful credit authorization answer with a
certain amount of credit resources, the credit-control client allows
service delivery to the end user and starts monitoring the usage of
the granted resources. When the credit resources granted to the user
have been consumed or the service has been successfully delivered or
terminated, the credit-control client reports back to the server the
used amount. The credit-control server deducts the used amount from
the end user's account; it may perform rating and make a new credit
reservation if the service delivery is continuing. This process is
accomplished with session-based credit-control that includes the
first interrogation, possible intermediate interrogations, and the
final interrogation. For session-based credit-control, both the
credit-control client and the credit-control server are required to
maintain credit-control session state. Session-based credit-control
is described in more detail, with more variations, in <a href="#section-5">Section 5</a>.
<span class="grey">Bertz, et al. Standards Track [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
In contrast, credit authorization with direct debiting is a
single-transaction process wherein the credit-control server directly
deducts a suitable amount of money from the user's account as soon as
the credit authorization request is received. Upon receipt of a
successful credit authorization answer, the credit-control client
allows service delivery to the end user. This process is
accomplished with the one-time event. Session state is not
maintained.
In a multi-service environment, an end user can issue an additional
service request (e.g., data service) during an ongoing service (e.g.,
voice call) toward the same account. Alternatively, during an active
multimedia session, an additional media type is added to the session,
causing a new simultaneous request toward the same account.
Consequently, this needs to be considered when credit resources are
granted to the services.
The credit-control application also supports operations such as
service price inquiries, user's balance checks, and refunds of credit
on the user's account. These operations are accomplished with the
one-time event. Session state is not maintained.
Flexible failure handling, specific to the credit-control
application, is defined in the application. This allows the service
provider to control the credit-control client's behavior according to
its own risk management policy.
The Credit-Control-Failure-Handling AVP (also referred to as the
CCFH) and the Direct-Debiting-Failure-Handling AVP (also referred to
as the DDFH) are defined to determine what is done if the sending of
credit-control messages to the credit-control server has been
temporarily prevented. The usage of the CCFH and the DDFH allows
flexibility, as failure handling for the credit-control session and
one-time event direct debiting may be different.
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. Service-Specific Rating Input and Interoperability</span>
The Diameter Credit-Control application defines the framework for
credit-control; it provides generic credit-control mechanisms
supporting multiple service applications. The credit-control
application therefore does not define AVPs that could be used as
input in the rating process. Listing the possible services that
could use this Diameter application is out of scope for this generic
mechanism.
<span class="grey">Bertz, et al. Standards Track [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
It is reasonable to expect that a service level agreement will exist
between providers of the credit-control client and the credit-control
server covering the charging, services offered, roaming agreements,
agreed-upon rating input (i.e., AVPs), and so on.
Therefore, it is assumed that a Diameter Credit-Control server will
provide service only for Diameter Credit-Control clients that have
agreed beforehand as to the content of credit-control messages.
Naturally, it is possible that any arbitrary Diameter Credit-Control
client can interchange credit-control messages with any Diameter
Credit-Control server, but with a higher likelihood that unsupported
services/AVPs could be present in the credit-control message, causing
the server to reject the request with an appropriate Result-Code.
<span class="h4"><a class="selflink" id="section-4.1.1" href="#section-4.1.1">4.1.1</a>. Specifying Rating Input AVPs</span>
There are two ways to provide rating input to the credit-control
server: by either using AVPs or including the rating input in the
Service-Parameter-Info AVP. The general principles for sending
rating parameters are as follows:
1. Using AVPs:
A. The service SHOULD reuse existing AVPs if it can use AVPs
defined in existing Diameter applications (e.g., [<a href="./rfc7155" title=""Diameter Network Access Server Application"">RFC7155</a>]
for network access services). [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>] strongly recommends
the reuse of existing AVPs.
For AVPs of type Enumerated, the service may require a new
value to be defined. Allocation of new AVP values is done as
specified in <a href="./rfc6733#section-1.3">[RFC6733], Section 1.3</a>.
B. New AVPs can be defined if the existing AVPs do not provide
sufficient rating information. In this case, the procedures
defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>] for creating new AVPs MUST be followed.
C. For services specific only to one vendor's implementation, a
vendor-specific AVP code for private use can be used. Where
a vendor-specific AVP is implemented by more than one vendor,
allocation of global AVPs is encouraged instead; refer to
[<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>].
2. The Service-Parameter-Info AVP MAY be used as a container to pass
legacy rating information in its original encoded form (e.g.,
ASN.1 BER). This method can be used to avoid unnecessary
conversions from an existing data format to an AVP format. In
this case, the rating input is embedded in the Service-Parameter-
Info AVP as defined in <a href="#section-8.43">Section 8.43</a>.
<span class="grey">Bertz, et al. Standards Track [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
New service applications SHOULD favor the use of explicitly defined
AVPs as described in items 1a and 1b, to simplify interoperability.
<span class="h4"><a class="selflink" id="section-4.1.2" href="#section-4.1.2">4.1.2</a>. Service-Specific Documentation</span>
The service-specific rating input AVPs, and the contents of the
Service-Parameter-Info AVP or Service-Context-Id AVP (defined in
<a href="#section-8.42">Section 8.42</a>), are not within the scope of this document. To
facilitate interoperability, it is RECOMMENDED that the rating input
and the values of the Service-Context-Id be coordinated via an
informational RFC or other permanent and readily available reference
(preferably that of another cooperative standardization body, e.g.,
3GPP, the Open Mobile Alliance (OMA), or 3GPP2). However, private
services may be deployed that are subject to agreements between
providers of the credit-control server and client. In this case,
vendor-specific AVPs can be used.
This specification, together with the above-mentioned service-
specific documents, governs the credit-control message. Service-
specific documents (i.e., those documents that do not define new
credit-control applications) define which existing AVPs or new AVPs
are used as input to the rating process; thus, the AVPs in question
have to be included in the Credit-Control-Request command by a
Diameter Credit-Control client supporting a given service as
"* [AVP]". Should the Service-Parameter-Info AVP be used, the
service-specific document MUST specify the exact content of this
Grouped AVP.
The Service-Context-Id AVP MUST be included at the command level of a
Credit-Control-Request to identify the service-specific document that
applies to the request. The specific service or rating-group the
request relates to is uniquely identified by the combination of
Service-Context-Id and Service-Identifier or rating-group.
<span class="h4"><a class="selflink" id="section-4.1.3" href="#section-4.1.3">4.1.3</a>. Handling of Unsupported/Incorrect Rating Input</span>
Diameter Credit-Control implementations are required to support
mandatory rating-related AVPs defined in service-specific documents
for the services they support, according to the 'M' bit rules in
[<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>].
If a rating input required for the rating process is incorrect in
the Credit-Control-Request or if the credit-control server does not
support the requested service context (identified by the
Service-Context-Id AVP at the command level), the
Credit-Control-Answer MUST contain the error code
DIAMETER_RATING_FAILED. A CCA message with this error MUST contain
one or more Failed-AVP AVPs containing the missing and/or unsupported
<span class="grey">Bertz, et al. Standards Track [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
AVPs that caused the failure. A Diameter Credit-Control client that
receives the error code DIAMETER_RATING_FAILED in response to a
request MUST NOT send similar requests in the future.
<span class="h4"><a class="selflink" id="section-4.1.4" href="#section-4.1.4">4.1.4</a>. RADIUS Vendor-Specific Rating Attributes</span>
When service-specific documents include RADIUS vendor-specific
attributes that could be used as input in the rating process, the
rules described in [<a href="./rfc7155" title=""Diameter Network Access Server Application"">RFC7155</a>] for formatting the Diameter AVP MUST be
followed.
For example, if the AVP code used is the vendor attribute type code,
the Vendor-Specific flag MUST be set to 1 and the Vendor-Id MUST be
set to the IANA Vendor identification value. The Diameter AVP Data
field contains only the attribute value of the RADIUS attribute.
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Session-Based Credit-Control</span>
<span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>. General Principles</span>
For session-based credit-control, several interrogations are needed:
the first, the intermediate (optional), and the final. This is
illustrated in Figures 3 and 4 (Sections <a href="#section-5.2.1">5.2.1</a> and <a href="#section-5.2.2">5.2.2</a>).
If the credit-control client performs credit reservation before
granting service to the end user, it MUST use several interrogations
toward the credit-control server (i.e., session-based
credit-control). In this case, the credit-control server MUST
maintain the credit-control session state.
Each credit-control session MUST have a globally unique Session-Id as
defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]; this Session-Id MUST NOT be changed during the
lifetime of a credit-control session.
Certain applications require multiple credit-control sub-sessions.
These applications would send messages with a constant Session-Id AVP
but with a different CC-Sub-Session-Id AVP. If several credit
sub-sessions will be used, all sub-sessions MUST be closed separately
before the main session is closed so that units per sub-session may
be reported. The absence of the CC-Sub-Session-Id AVP implies that
no sub-sessions are in use.
<span class="grey">Bertz, et al. Standards Track [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Note that the Service Element might send a service-specific
re-authorization message to the AAA server due to expiration of the
authorization lifetime during an ongoing credit-control session.
However, the service-specific re-authorization does not influence the
credit authorization that is ongoing between the credit-control
client and credit-control server, as credit authorization is
controlled by the burning rate of the granted quota.
If service-specific re-authorization fails, the user will be
disconnected, and the credit-control client MUST send a final
interrogation to the credit-control server.
The Diameter Credit-Control server may seek to control the validity
time of the granted quota and/or the production of intermediate
interrogations. Thus, it MAY include the Validity-Time AVP in the
Answer message to the credit-control client. Upon expiration of the
Validity-Time, the credit-control client MUST generate a
credit-control update request and report the used quota to the
credit-control server. It is up to the credit-control server to
determine the value of the Validity-Time to be used for consumption
of the granted service unit(s) (G-S-U). If the Validity-Time is
used, its value SHOULD be given as input to set the session
supervision timer Tcc (the session supervision timer MAY be set to
two times the value of the Validity-Time, as defined in <a href="#section-13">Section 13</a>).
Since credit-control update requests are also produced at the expiry
of granted service units and/or for mid-session service events, the
omission of Validity-Time does not mean that intermediate
interrogation for the purpose of credit-control is not performed.
<span class="h4"><a class="selflink" id="section-5.1.1" href="#section-5.1.1">5.1.1</a>. Basic Support for Tariff Time Change</span>
The Diameter Credit-Control server and client MAY optionally support
a tariff change mechanism. The Diameter Credit-Control server may
include a Tariff-Time-Change AVP in the Answer message. Note that
the granted units should be allocated based on the worst-case
scenario, so that the overall reported used units would never exceed
the credit reservation. For example, in the case of a forthcoming
tariff change, in which the new rate is higher, the allocation should
be given so it does not exceed the credit, assuming that all of it is
used after the tariff changed.
When the Diameter Credit-Control client reports the used units and a
tariff change has occurred during the reporting period, the Diameter
Credit-Control client MUST separately itemize the units used before
and after the tariff change. If the client is unable to distinguish
whether units straddling the tariff change were used before or after
the tariff change, the credit-control client MUST itemize those units
in a third category.
<span class="grey">Bertz, et al. Standards Track [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
If a client does not support the tariff change mechanism and it
receives a CCA message carrying the Tariff-Time-Change AVP, it MUST
terminate the credit-control session, giving a reason of
DIAMETER_BAD_ANSWER in the Termination-Cause AVP.
For time-based services, the quota is consumed at the rate of the
passage of real time (ignoring leap seconds). That is, precisely
1 second of quota is consumed per second of real time. At the time
when credit resources are allocated, the server already knows how
many units will be consumed before the tariff time change and how
many units will be consumed afterward. Similarly, the server can
determine the units consumed at the "before" rate and the units
consumed at the "afterward" rate in the event that the end user
closes the session before the consumption of the allotted quota.
There is no need for additional traffic between the client and server
in the case of tariff time changes for continuous time-based service.
Therefore, the tariff change mechanism is not used for such services.
For time-based services in which the quota is NOT continuously
consumed at a regular rate, the tariff change mechanism described for
volume and event units MAY be used.
<span class="h4"><a class="selflink" id="section-5.1.2" href="#section-5.1.2">5.1.2</a>. Credit-Control for Multiple Services within a (Sub-)Session</span>
When multiple services are used within the same user session and each
service or group of services is subject to different cost, it is
necessary to perform credit-control for each service independently.
Making use of credit-control sub-sessions to achieve independent
credit-control will result in increased signaling load and usage of
resources in both the credit-control client and the credit-control
server. For instance, during one network access session, the
end user may use several HTTP-based services that could be charged
with different costs. The network-access-specific attributes, such
as Quality of Service (QoS), are common to all the services carried
within the access bearer, but the cost of the bearer may vary,
depending on its content.
To support these scenarios optimally, the credit-control application
enables independent credit-control of multiple services in a single
credit-control (sub-)session. This is achieved by including the
optional Multiple-Services-Credit-Control AVP in Credit-Control-
Request/Credit-Control-Answer messages. It is possible to request
and allocate resources as a credit pool shared between multiple
services. The services can be grouped into rating-groups in order to
achieve even further aggregation of credit allocation. It is also
possible to request and allocate quotas on a per-service basis.
Where quotas are allocated to a pool by means of the Multiple-
Services-Credit-Control AVP, the quotas remain independent objects
<span class="grey">Bertz, et al. Standards Track [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
that can be re-authorized independently at any time. Quotas can also
be given independent result codes, validity times, and Final-Unit-
Indication AVP values or QoS-Final-Unit-Indication AVP values.
A rating-group gathers a set of services, identified by a Service-
Identifier and subject to the same cost and rating type (e.g.,
$0.1/minute). It is assumed that the Service Element is provided
with rating-groups, service-identifiers, and their associated
parameters that define what has to be metered by means outside the
scope of this specification. (Examples of parameters associated to
service-identifiers are IP 5-tuples and HTTP URLs.) Service-
identifiers enable authorization on a per-service-based credit as
well as itemized reporting of service usage. It is up to the
credit-control server whether to authorize credit for one or more
services or for the whole rating-group. However, the client SHOULD
always report used units at the finest supported level of
granularity. Where a quota is allocated to a rating-group, all the
services belonging to that group draw from the allotted quota.
Figure 2 provides a graphical representation of the relationship
between service-identifiers, rating-groups, credit pools, and
credit-control (sub-)sessions.
Diameter Credit-Control (Sub-)Session
|
+------------+-----------+-------------+--------------- +
| | | | |
Service-Id a Service-Id b Service-Id c Service-Id d.....Service-Id z
\ / \ / /
\ / \ / /
\ / Rating-Group 1.......Rating-Group n
\ / | |
Quota ---------------Quota Quota
| / |
| / |
Credit Pool Credit Pool
Figure 2: Multiple-Service (Sub-)Session Example
If independent credit-control of multiple services is used, the
Validity-Time AVP, and the Final-Unit-Indication AVP or
QoS-Final-Unit-Indication AVP, SHOULD be present either in the
Multiple-Services-Credit-Control AVP(s) or at the command level as
single AVPs. However, the Result-Code AVP MAY be present both at the
command level and within the Multiple-Services-Credit-Control AVP.
If the Result-Code AVP at the command level indicates a value other
than SUCCESS, then the Result-Code AVP at the command level takes
precedence over any other AVPs included in the Multiple-Services-
Credit-Control AVP.
<span class="grey">Bertz, et al. Standards Track [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
The credit-control client MUST indicate support for independent
credit-control of multiple services within a (sub-)session by
including the Multiple-Services-Indicator AVP in the first
interrogation. A credit-control server not supporting this feature
MUST treat the Multiple-Services-Indicator AVP and any received
Multiple-Services-Credit-Control AVPs as invalid AVPs.
If the client indicated support for independent credit-control of
multiple services, a credit-control server that wishes to use the
feature MUST return the granted units within the Multiple-Services-
Credit-Control AVP associated to the corresponding service-identifier
and/or rating-group.
To avoid a situation where several parallel (and typically also
small) credit reservations must be made on the same account (i.e.,
credit fragmentation), and also to avoid unnecessary load on the
credit-control server, it is possible to provide service units as a
pool that applies to multiple services or rating-groups. This is
achieved by providing the service units in the form of a quota for a
particular service or rating-group in the Multiple-Services-Credit-
Control AVP, and also by including a reference to a credit pool for
that unit type.
The reference includes a multiplier derived from the rating
parameter, which translates from service units of a specific type to
the abstract service units in the pool. For instance, if the rating
parameter for service 1 is $1/MB and the rating parameter for
service 2 is $0.5/MB, the multipliers could be 10 and 5 for
services 1 and 2, respectively.
If (1) S is the total service units within the pool, (2) M1, M2, ...,
Mn are the multipliers provided for services 1, 2, ..., n, and
(3) C1, C2, ..., Cn are the used resources within the session, then
the pool's credit is exhausted and re-authorization MUST be sought
when:
C1*M1 + C2*M2 + ... + Cn*Mn >= S
The total credit in the pool, S, is calculated from the quotas, which
are currently allocated to the pool as follows:
S = Q1*M1 + Q2*M2 + ... + Qn*Mn
If services or rating-groups are added to or removed from the pool,
then the total credit is adjusted appropriately. Note that when the
total credit is adjusted because services or rating-groups are
removed from the pool, the value that needs to be removed is the
consumed one (i.e., Cx*Mx).
<span class="grey">Bertz, et al. Standards Track [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Re-authorizations for an individual service or rating-group may be
sought at any time -- for example, if a "non-pooled" quota is used up
or the Validity-Time expires.
Where multiple G-S-U-Pool-Reference AVPs (<a href="#section-8.30">Section 8.30</a>) with the same
G-S-U-Pool-Identifier are provided within a Multiple-Services-Credit-
Control AVP (<a href="#section-8.16">Section 8.16</a>) along with the Granted-Service-Unit AVP,
these AVPs MUST have different CC-Unit-Type values, and they all draw
from the credit pool separately. For instance, if one multiplier for
time (M1t) and one multiplier for volume (M1v) are given, then the
used resources from the pool yield the sum of C1t*M1t + C1v*M1v,
where C1t is the time unit and C1v is the volume unit.
Where service units are provided within a Multiple-Services-Credit-
Control AVP without a corresponding G-S-U-Pool-Reference AVP, these
units are handled independently from any credit pools and from any
other services or rating-groups within the session.
The "credit pool" concept is an optimal tool to avoid the
over-reservation effect of the basic single-quota tariff time change
mechanism (<a href="#section-5.1.1">Section 5.1.1</a>). Therefore, Diameter Credit-Control
clients and servers implementing the independent credit-control of
multiple services SHOULD leverage the credit pool concept when
supporting the tariff time change. The Diameter Credit-Control
server SHOULD include both the Tariff-Time-Change AVP and the
Tariff-Change-Usage AVP in two quota allocations in the Answer
message (i.e., two instances of the Multiple-Services-Credit-Control
AVP). One of the grants is allocated to be used before the potential
tariff change, while the second grant is for use after a tariff
change. Both granted unit quotas MUST contain the same Service-
Identifier and/or rating-group. This dual-quota mechanism ensures
that the overall reported used units would never exceed the credit
reservation. The Diameter Credit-Control client reports the used
units both before and after the tariff change in a single instance of
the Multiple-Services-Credit-Control AVP.
Failure handling for credit-control sessions is defined in
<a href="#section-5.7">Section 5.7</a> and reflected in the basic credit-control state machines
defined in <a href="#section-7">Section 7</a>. Credit-control clients and servers
implementing the functionality of independent credit-control of
multiple services in a (sub-)session MUST ensure failure handling and
general behavior fully consistent with Sections <a href="#section-5.7">5.7</a> and <a href="#section-7">7</a> while
maintaining the ability to handle parallel ongoing credit
re-authorization within a (sub-)session. Therefore, it is
RECOMMENDED that Diameter Credit-Control clients maintain a PendingU
message queue (<a href="#section-7">Section 7</a>) and restart the Tx timer (<a href="#section-13">Section 13</a>) every
time a CCR message with the value UPDATE_REQUEST is sent while they
are in PendingU state. When answers to all pending messages are
<span class="grey">Bertz, et al. Standards Track [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
received, the state machine moves to Open state, and the Tx timer is
stopped. Naturally, when a problem is detected and acted upon per
<a href="#section-5.7">Section 5.7</a>, all of the ongoing services are affected (e.g., failover
to a backup server affects all of the CCR messages in the PendingU
queue).
Since the client may send CCR messages with the value UPDATE_REQUEST
while in PendingU state (i.e., without waiting for an answer to
ongoing credit re-authorization), the time space between these
requests may be very short, and the server may not have received the
previous request(s) yet. Therefore, in this situation the server may
receive out-of-sequence requests and SHOULD NOT consider this an
error condition. A proper answer is to be returned to each of those
requests.
<span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>. First Interrogation</span>
When session-based credit-control is required (e.g., the
authentication server indicated a prepaid user), the first
interrogation MUST be sent before the Diameter Credit-Control client
allows any service events for the end user. The CC-Request-Type AVP
is set to the value INITIAL_REQUEST in the request message.
If the Diameter Credit-Control client knows the cost of the service
event (e.g., a content server delivering ringing tones may know their
cost) the monetary amount to be charged is included in the Requested-
Service-Unit AVP. If the Diameter Credit-Control client does not
know the cost of the service event, the Requested-Service-Unit AVP
MAY contain the number of requested service events. Where the
Multiple-Services-Credit-Control AVP is used, it MUST contain the
Requested-Service-Unit AVP to indicate that the quota for the
associated service/rating-group is requested. In the case of
multiple services, the Service-Identifier AVP or the Rating-Group AVP
within the Multiple-Services-Credit-Control AVP always indicates the
service concerned. Additional service event information to be rated
MAY be sent as service-specific AVPs or MAY be sent within the
Service-Parameter-Info AVP at the command level. The
Service-Context-Id AVP indicates the service-specific document
applicable to the request.
The Event-Timestamp AVP SHOULD be included in the request and
contains the time when the service event is requested in the Service
Element. The Subscription-Id AVP or the Subscription-Id-Extension
AVP SHOULD be included to identify the end user in the credit-control
server. The credit-control client MAY include the User-Equipment-
Info AVP or User-Equipment-Info-Extension AVP so that the
<span class="grey">Bertz, et al. Standards Track [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
credit-control server has some indication of the type and
capabilities of the end-user access device. How the credit-control
server uses this information is outside the scope of this document.
The credit-control server SHOULD rate the service event and make a
credit reservation from the end user's account that covers the cost
of the service event. If the type of the Requested-Service-Unit AVP
is "money", no rating is needed, but the corresponding monetary
amount is reserved from the end user's account.
The credit-control server returns the Granted-Service-Unit AVP in the
Answer message to the Diameter Credit-Control client. The Granted-
Service-Unit AVP contains the amount of service units that the
Diameter Credit-Control client can provide to the end user until a
new Credit-Control-Request MUST be sent to the credit-control server.
If several unit types are sent in the Answer message, the
credit-control client MUST handle each unit type separately. The
type of the Granted-Service-Unit AVP can be time, volume, service-
specific, or money, depending on the type of service event. The unit
type(s) SHOULD NOT be changed within an ongoing credit-control
session.
There MUST be a maximum of one instance of the same unit type in one
Answer message. However, if multiple quotas are conveyed to the
credit-control client in the Multiple-Services-Credit-Control AVPs,
it is possible to carry two instances of the same unit type
associated to a service-identifier/rating-group. This is typically
the case when a tariff time change is expected and the credit-control
server wants to make a distinction between the granted quota before
the tariff change and the granted quota after the tariff change.
If the credit-control server determines that no further control is
needed for the service, it MAY include the result code indicating
that the credit-control is not applicable (e.g., if the service is
free of charge). This result code, at the command level, implies
that the credit-control session is to be terminated.
The Credit-Control-Answer message MAY also include the Final-Unit-
Indication AVP or the QoS-Final-Unit-Indication AVP to indicate that
the Answer message contains the final units for the service. After
the end user has consumed these units, the Diameter Credit-Control
client MUST behave as described in <a href="#section-5.6">Section 5.6</a>.
This document defines two different approaches for performing the
first interrogation to be used in different network architectures.
The first approach uses credit-control messages after the user's
authorization and authentication take place. The second approach
uses (1) service-specific authorization messages to perform the first
<span class="grey">Bertz, et al. Standards Track [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
interrogation during the user's authorization/authentication phase
and (2) credit-control messages for the intermediate and final
interrogations. If an implementation of the credit-control client
supports both methods, determining which method to use SHOULD be
configurable.
In service environments such as NAS environments, it is desired to
perform the first interrogation as part of the authorization/
authentication process for the sake of protocol efficiency. Further
credit authorizations after the first interrogation are performed
with credit-control commands defined in this specification.
Implementations of credit-control clients operating in the
environments mentioned in this document SHOULD support this method.
If the credit-control server and AAA server are separate physical
entities, the Service Element sends the request messages to the AAA
server, which then issues an appropriate request or proxies the
received request forward to the credit-control server.
In other service environments, such as the 3GPP network and some SIP
scenarios, there is a substantial decoupling between registration/
access to the network and the actual service request (i.e., the
authentication/authorization is executed once during registration/
access to the network and is not executed for every service event
requested by the subscriber). In these environments, it is more
appropriate to perform the first interrogation after the user has
been authenticated and authorized. The first, intermediate, and
final interrogations are executed with credit-control commands
defined in this specification.
Other IETF standards or standards developed by other standardization
bodies may define the most suitable method in their architectures.
<span class="h4"><a class="selflink" id="section-5.2.1" href="#section-5.2.1">5.2.1</a>. First Interrogation after Authorization and Authentication</span>
The Diameter Credit-Control client in the Service Element may get
information from the authorization server as to whether
credit-control is required, based on its knowledge of the end user.
If credit-control is required, the credit-control server needs to be
contacted prior to initiating service delivery to the end user. The
accounting protocol and the credit-control protocol can be used in
parallel. The authorization server may also determine whether the
parallel accounting stream is required.
<span class="grey">Bertz, et al. Standards Track [Page 25]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Figure 3 illustrates the case where both protocols are used in
parallel and the Service Element sends credit-control messages
directly to the credit-control server. More credit-control sequence
examples are given in <a href="#appendix-A">Appendix A</a>.
Diameter
End User Service Element AAA Server CC Server
(CC Client)
| Registration | AA-Request/Answer(accounting, CC, or both)|
|<----------------->|<------------------>| |
| : | | |
| : | | |
| Service Request | | |
|------------------>| | |
| | CCR(Initial, Credit-Control AVPs) |
| +|------------------------------------------>|
| CC stream|| | CCA(Granted-Units)|
| +|<------------------------------------------|
| Service Delivery | | |
|<----------------->| ACR(start, Accounting AVPs) |
| : |------------------->|+ |
| : | ACA || Accounting stream |
| |<-------------------|+ |
| : | | |
| : | | |
| | CCR(Update, Used-Units) |
| |------------------------------------------>|
| | | CCA(Granted-Units)|
| |<------------------------------------------|
| : | | |
| : | | |
| End of Service | | |
|------------------>| CCR(Termination, Used-Units) |
| |------------------------------------------>|
| | | CCA |
| |<------------------------------------------|
| | ACR(stop) | |
| |------------------->| |
| | ACA | |
| |<-------------------| |
ACR: Accounting-Request
ACA: Accounting-Answer
Figure 3: Protocol Example with First Interrogation
after User's Authorization/Authentication
<span class="grey">Bertz, et al. Standards Track [Page 26]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h4"><a class="selflink" id="section-5.2.2" href="#section-5.2.2">5.2.2</a>. First Interrogation Included with Authorization Messages</span>
The Diameter Credit-Control client in the Service Element MUST
actively co-operate with the authorization/authentication client in
the construction of the AA-Request by adding appropriate
Credit-Control AVPs. The credit-control client MUST add the
Credit-Control AVP to indicate credit-control capabilities and MAY
add other relevant credit-control-specific AVPs to the proper
authorization/authentication command to perform the first
interrogation toward the home Diameter AAA server. The
Auth-Application-Id is set to the appropriate value, as defined in
service-specific authorization/authentication application document
(e.g., [<a href="./rfc7155" title=""Diameter Network Access Server Application"">RFC7155</a>] [<a href="./rfc4004" title=""Diameter Mobile IPv4 Application"">RFC4004</a>]). The home Diameter AAA server
authenticates/authorizes the subscriber and determines whether
credit-control is required.
If credit-control is not required for the subscriber, the home
Diameter AAA server will respond as usual, with an appropriate
AA-Answer message. If credit-control is required for the subscriber
and the Credit-Control AVP with the value set to CREDIT_AUTHORIZATION
was present in the authorization request, the home AAA server MUST
contact the credit-control server to perform the first interrogation.
If credit-control is required for the subscriber and the
Credit-Control AVP was not present in the authorization request, the
home AAA server MUST send an authorization reject Answer message.
The Diameter AAA server supporting credit-control is required to send
the Credit-Control-Request command (CCR) defined in this document to
the credit-control server. The Diameter AAA server populates the CCR
based on service-specific AVPs used for input to the rating process,
and possibly on Credit-Control AVPs received in the AA-Request. The
credit-control server will reserve money from the user's account,
will rate the request, and will send a Credit-Control-Answer message
to the home Diameter AAA server. The Answer message includes the
Granted-Service-Unit AVP(s) and MAY include other credit-control-
specific AVPs, as appropriate. Additionally, the credit-control
server MAY set the Validity-Time and MAY include the CCFH and the
DDFH to determine what to do if the sending of credit-control
messages to the credit-control server has been temporarily prevented.
Upon receiving the Credit-Control-Answer message from the
credit-control server, the home Diameter AAA server will populate the
AA-Answer with the received Credit-Control AVPs and with the
appropriate service attributes according to the authorization/
authentication-specific application (e.g., [<a href="./rfc7155" title=""Diameter Network Access Server Application"">RFC7155</a>] [<a href="./rfc4004" title=""Diameter Mobile IPv4 Application"">RFC4004</a>]). It
will then forward the packet to the credit-control client. If the
home Diameter AAA server receives a credit-control reject message, it
<span class="grey">Bertz, et al. Standards Track [Page 27]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
will simply generate an appropriate authorization reject message to
the credit-control client, including the credit-control-specific
error code.
In this model, the credit-control client sends further credit-control
messages to the credit-control server via the home Diameter AAA
server. Upon receiving a successful authorization Answer message
with the Granted-Service-Unit AVP(s), the credit-control client will
grant the service to the end user and will generate an intermediate
Credit-Control-Request, if required, by using credit-control
commands. The CC-Request-Number of the first UPDATE_REQUEST MUST be
set to 1 (for details regarding how to produce a unique value for the
CC-Request-Number AVP, see <a href="#section-8.2">Section 8.2</a>).
If service-specific re-authorization is performed (i.e., the
authorization lifetime expires), the credit-control client MUST add
to the service-specific re-authorization request the Credit-Control
AVP with a value set to RE_AUTHORIZATION to indicate that the
credit-control server MUST NOT be contacted. When session-based
credit-control is used for the subscriber, a constant credit-control
message stream flows through the home Diameter AAA server. The home
Diameter AAA server can make use of this credit-control message flow
to deduce that the user's activity is ongoing; therefore, it is
recommended to set the authorization lifetime to a reasonably high
value when credit-control is used for the subscriber.
In this scenario, the home Diameter AAA server MUST advertise support
for the credit-control application to its peers during the capability
exchange process.
<span class="grey">Bertz, et al. Standards Track [Page 28]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Figure 4 illustrates the use of authorization/authentication messages
to perform the first interrogation. The parallel accounting stream
is not shown in the figure.
Diameter
Service Element AAA Server CC Server
End User (CC Client)
| Service Request | AA-Request (CC AVPs) | |
|------------------>|--------------------->| |
| | | CCR(Initial, CC AVPs)
| | |-------------------->|
| | | CCA(Granted-Units)|
| | |<--------------------|
| | AA-Answer(Granted-Units) |
| Service Delivery |<---------------------| |
|<----------------->| | |
| : | | |
| : | | |
| : | | |
| | | |
| | CCR(Update, Used-Units) |
| |--------------------->| CCR(Update, Used-Units)
| | |-------------------->|
| | | CCA(Granted-Units)|
| | CCA(Granted-Units)|<--------------------|
| |<---------------------| |
| : | | |
| : | | |
| End of Service | | |
|------------------>| CCR(Termination, Used-Units) |
| |--------------------->| CCR(Term., Used-Units)
| | |-------------------->|
| | | CCA |
| | CCA |<--------------------|
| |<---------------------| |
Figure 4: Protocol Example with Use of Authorization Messages
for the First Interrogation
<span class="h3"><a class="selflink" id="section-5.3" href="#section-5.3">5.3</a>. Intermediate Interrogation</span>
When all the granted service units for one unit type are spent by the
end user or the Validity-Time has expired, the Diameter
Credit-Control client MUST send a new Credit-Control-Request to the
credit-control server. In the event that credit-control for multiple
services is applied in one credit-control session (i.e., units
associated to Service-Identifier(s) or the rating-group are granted),
a new Credit-Control-Request MUST be sent to the credit-control
<span class="grey">Bertz, et al. Standards Track [Page 29]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
server when the credit reservation has been wholly consumed or upon
expiration of the Validity-Time. It is always up to the Diameter
Credit-Control client to send a new request well in advance of the
expiration of the previous request in order to avoid interruption in
the Service Element. Even if the granted service units reserved by
the credit-control server have not been spent upon expiration of the
Validity-Time, the Diameter Credit-Control client MUST send a new
Credit-Control-Request to the credit-control server.
There can also be mid-session service events, which might affect the
rating of the current service events. In this case, a spontaneous
update (a new Credit-Control-Request) SHOULD be sent, including
information related to the service event, even if all the granted
service units have not been spent or the Validity-Time has not
expired.
When the used units are reported to the credit-control server, the
credit-control client will not have any units in its possession
before new granted units are received from the credit-control server.
When the new granted units are received, these units apply from the
point where the measurement of the reported used units stopped.
Where independent credit-control of multiple services is supported,
this process may be executed for one or more services, a single
rating-group, or a pool within the (sub-)session.
The CC-Request-Type AVP is set to the value UPDATE_REQUEST in the
intermediate request message. The Subscription-Id AVP or
Subscription-Id-Extension AVP SHOULD be included in the intermediate
message to identify the end user in the credit-control server. The
Service-Context-Id AVP indicates the service-specific document
applicable to the request.
The Requested-Service-Unit AVP MAY contain the new amount of
requested service units. Where the Multiple-Services-Credit-Control
AVP is used, it MUST contain the Requested-Service-Unit AVP if a new
quota is requested for the associated service/rating-group. The
Used-Service-Unit AVP contains the amount of used service units
measured from the point when the service became active or, if interim
interrogations are used during the session, from the point when the
previous measurement ended. The same unit types used in the previous
message SHOULD be used. If several unit types were included in the
previous Answer message, the used service units for each unit type
MUST be reported.
The Event-Timestamp AVP SHOULD be included in the request and
contains the time of the event that triggered the sending of the new
Credit-Control-Request.
<span class="grey">Bertz, et al. Standards Track [Page 30]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
The credit-control server MUST deduct the used amount from the
end user's account. It MAY rate the new request and make a new
credit reservation from the end user's account that covers the cost
of the requested service event.
A Credit-Control-Answer message with the CC-Request-Type AVP set to
the value UPDATE_REQUEST MAY include the Cost-Information AVP
containing the accumulated cost estimation for the session, without
taking any credit reservations into account.
The Credit-Control-Answer message MAY also include the Final-Unit-
Indication AVP or the QoS-Final-Unit-Indication AVP to indicate that
the Answer message contains the final units for the service. After
the end user has consumed these units, the Diameter Credit-Control
client MUST behave as described in <a href="#section-5.6">Section 5.6</a>.
There can be several intermediate interrogations within a session.
<span class="h3"><a class="selflink" id="section-5.4" href="#section-5.4">5.4</a>. Final Interrogation</span>
When the end user terminates the service session or when graceful
service termination (described in <a href="#section-5.6">Section 5.6</a>) takes place, the
Diameter Credit-Control client MUST send a final Credit-Control-
Request message to the credit-control server. The CC-Request-Type
AVP is set to the value TERMINATION_REQUEST. The Service-Context-Id
AVP indicates the service-specific document applicable to the
request.
The Event-Timestamp AVP SHOULD be included in the request and
contains the time when the session was terminated.
The Used-Service-Unit AVP contains the amount of used service units
measured from the point when the service became active or, if interim
interrogations are used during the session, from the point when the
previous measurement ended. If several unit types were included in
the previous Answer message, the used service units for each unit
type MUST be reported.
After final interrogation, the credit-control server MUST refund the
reserved credit amount not used to the end user's account and deduct
the used monetary amount from the end user's account.
A Credit-Control-Answer message with the CC-Request-Type AVP set to
the value TERMINATION_REQUEST MAY include the Cost-Information AVP
containing the estimated total cost for the session in question.
<span class="grey">Bertz, et al. Standards Track [Page 31]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
If the user logs off during an ongoing credit-control session or if
the user becomes logged off for some other reason (e.g., a final-unit
indication causes user logoff according to local policy), the Service
Element, according to application-specific policy, may send a
Session-Termination-Request (STR) to the home Diameter AAA server as
usual [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]. Figure 5 illustrates the case when the final-unit
indication causes user logoff upon consumption of the final granted
units and the generation of an STR.
The Diameter AAA server responds with a Session-Termination-Answer
(STA).
Service Element AAA Server CC Server
End User (CC Client)
| Service Delivery | | |
|<----------------->| | |
| : | | |
| : | | |
| : | | |
| | | |
| | CCR(Update, Used-Units) |
| |-------------------->| CCR(Update, Used-Units)
| | |-------------------->|
| | CCA(Final-Unit, Terminate)
| CCA(Final-Unit, Terminate)|<--------------------|
| |<--------------------| |
| : | | |
| : | | |
| Disconnect user | | |
|<------------------| CCR(Termination, Used-Units) |
| |-------------------->| CCR(Term., Used-Units)
| | |-------------------->|
| | | CCA |
| | CCA |<--------------------|
| |<--------------------| |
| | STR | |
| |-------------------->| |
| | STA | |
| |<--------------------| |
Figure 5: User Disconnected Due to Exhausted Account
<span class="h3"><a class="selflink" id="section-5.5" href="#section-5.5">5.5</a>. Server-Initiated Credit Re-authorization</span>
The Diameter Credit-Control application supports server-initiated
re-authorization. The credit-control server MAY optionally initiate
the credit re-authorization by issuing a Re-Auth-Request (RAR) as
defined in the Diameter base protocol [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]. The
<span class="grey">Bertz, et al. Standards Track [Page 32]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Auth-Application-Id in the RAR message is set to 4 to indicate
"Diameter Credit Control", and the Re-Auth-Request-Type is set to
AUTHORIZE_ONLY.
<a href="#section-5.1.2">Section 5.1.2</a> defines the feature to enable credit-control for
multiple services within a single (sub-)session where the server can
authorize credit usage at a different level of granularity. Further,
the server may provide credit resources to multiple services or
rating-groups as a pool (see <a href="#section-5.1.2">Section 5.1.2</a> for details and
definitions). Therefore, the server, based on its service logic and
its knowledge of the ongoing session, can decide to request credit
re-authorization for a whole (sub-)session, a single credit pool, a
single service, or a single rating-group. To request credit
re-authorization for a credit pool, the server includes in the RAR
message the G-S-U-Pool-Identifier AVP indicating the affected pool.
To request credit re-authorization for a service or a rating-group,
the server includes in the RAR message the Service-Identifier AVP or
the Rating-Group AVP, respectively. To request credit
re-authorization for all the ongoing services within the
(sub-)session, the server includes none of the above-mentioned AVPs
in the RAR message.
If a credit re-authorization is not already ongoing (i.e., the
credit-control session is in Open state), a credit-control client
that receives an RAR message with Session-Id equal to a currently
active credit-control session MUST acknowledge the request by sending
the Re-Auth-Answer (RAA) message and MUST initiate the credit
re-authorization toward the server by sending a Credit-Control-
Request message with the CC-Request-Type AVP set to the value
UPDATE_REQUEST. The Result-Code 2002 (DIAMETER_LIMITED_SUCCESS)
SHOULD be used in the RAA message to indicate that an additional
message (i.e., a CCR message with the value UPDATE_REQUEST) is
required to complete the procedure. If a quota was allocated to the
service, the credit-control client MUST report the used quota in the
Credit-Control-Request. Note that the end user does not need to be
prompted for the credit re-authorization, since the credit
re-authorization is transparent to the user (i.e., it takes place
exclusively between the credit-control client and the credit-control
server).
Where multiple services in a user's session are supported, the
procedure in the above paragraph will be executed at the granularity
requested by the server in the RAR message.
If credit re-authorization is ongoing at the time when the RAR
message is received (i.e., an RAR-CCR collision), the credit-control
client successfully acknowledges the request but does not initiate a
new credit re-authorization. The Result-Code 2001 (DIAMETER_SUCCESS)
<span class="grey">Bertz, et al. Standards Track [Page 33]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
SHOULD be used in the RAA message to indicate that a credit
re-authorization procedure is already ongoing (i.e., the client was
in PendingU state when the RAR was received). The credit-control
server SHOULD process the Credit-Control-Request as if it was
received in answer to the server-initiated credit re-authorization
and should consider the server-initiated credit re-authorization
process successful upon reception of the RAA message.
When multiple services are supported in a user's session, the server
may request credit re-authorization for a credit pool (or for the
(sub-)session) while a credit re-authorization is already ongoing for
some of the services or rating-groups. In this case, the client
acknowledges the server request with an RAA message and MUST send a
new Credit-Control-Request message to perform re-authorization for
the remaining services/rating-groups. The Result-Code 2002
(DIAMETER_LIMITED_SUCCESS) SHOULD be used in the RAA message to
indicate that an additional message (i.e., a CCR message with the
value UPDATE_REQUEST) is required to complete the procedure. The
server processes the received requests and returns an appropriate
answer to both requests.
The above-defined procedures are enabled for each of the possibly
active Diameter Credit-Control sub-sessions. The server MAY request
re-authorization for an active sub-session by including the
CC-Sub-Session-Id AVP in the RAR message in addition to the
Session-Id AVP.
<span class="h3"><a class="selflink" id="section-5.6" href="#section-5.6">5.6</a>. Graceful Service Termination</span>
When the user's account runs out of money, the user may not be
allowed to compile additional chargeable events. However, the home
service provider may offer some services -- for instance, access to a
service portal where it is possible to refill the account -- from
which the user is allowed to benefit for a limited time. The length
of this time is usually dependent on the home service provider
policy.
This section defines the optional graceful service termination
feature. This feature MAY be supported by the credit-control server.
Credit-control client implementations MUST support the Final-Unit-
Indication AVP or QoS-Final-Unit-Indication AVP with at least the
teardown of the ongoing service session once the subscriber has
consumed all the final granted units.
<span class="grey">Bertz, et al. Standards Track [Page 34]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Where independent credit-control of multiple services in a single
credit-control (sub-)session is supported, it is possible to use
graceful service termination for each of the services/rating-groups
independently. Naturally, the graceful service termination process
defined in the following subsections will apply to the specific
service/rating-group as requested by the server.
In some service environments (e.g., NAS), graceful service
termination may be used to redirect the subscriber to a service
portal for online balance refill or other services offered by the
home service provider. In this case, the graceful service
termination process installs a set of packet filters to restrict the
user's access capability only to/from the specified destinations.
All the IP packets not matching the filters will be dropped or,
possibly, redirected to the service portal. The user may also be
sent an appropriate notification as to why the access has been
limited. These actions may be communicated explicitly from the
server to the client or may be configured "per service" at the
client. Explicitly signaled redirection or restriction instructions
always take precedence over configured ones.
It is also possible to use graceful service termination to connect
the prepaid user to a top-up server that plays an announcement and
prompts the user to replenish the account. In this case, the
credit-control server sends only the address of the top-up server
where the prepaid user shall be connected after the final granted
units have been consumed. An example of this case is given in
<a href="#appendix-A.7">Appendix A.7</a>.
The credit-control server MAY initiate graceful service termination
by including the Final-Unit-Indication AVP or the
QoS-Final-Unit-Indication AVP in the Credit-Control-Answer to
indicate that the message contains the final units for the service.
When the credit-control client receives the Final-Unit-Indication AVP
or the QoS-Final-Unit-Indication AVP in the answer from the server,
its behavior depends on the value indicated in the Final-Unit-Action
AVP. The server may request the following actions: TERMINATE,
REDIRECT, or RESTRICT_ACCESS.
Figure 6 illustrates the graceful service termination procedure
described in the following subsections.
<span class="grey">Bertz, et al. Standards Track [Page 35]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Diameter
End User Service Element AAA Server CC Server
(CC Client)
| Service Delivery | | |
|<----------------->| | |
| |CCR(Update, Used-Units) |
| |-------------------->|CCR(Update, Used-Units)
| : | |-------------------->|
| : | |CCA(Final-Unit, Action)
| : | |<--------------------|
| |CCA(Final-Unit, Action) |
| |<--------------------| |
| | | |
| : | | |
| : | | |
| /////////////// |CCR(Update, Used-Units) |
|/Final Units End/->|-------------------->|CCR(Update, Used-Units)
|/Action and // | |-------------------->|
|/Restrictions // | | CCA(Validity-Time)|
|/Start // | CCA(Validity-Time)|<--------------------|
| ///////////// |<--------------------| |
| : | | |
| : | | |
| Replenish account | +-------+ |
|<--------------------------------------------->|Account| |
| | | +-------+ |
| | | RAR |
| + | RAR |<====================|
| | |<====================| |
| | | RAA | |
| ///////////// | |====================>| RAA |
| /If supported / | | CCR(Update) |====================>|
| /by CC Server/ | |====================>| CCR(Update) |
| ///////////// | | |====================>|
| | | | CCA(Granted-Units)|
| | | CCA(Granted-Units)|<====================|
| Restrictions ->+ |<====================| |
| removed | | |
| : | | |
| OR | CCR(Update) | |
| Validity-Time ->|-------------------->| CCR(Update) |
| expires | |-------------------->|
| | | CCA(Granted-Units)|
| | CCA(Granted-Units)|<--------------------|
| Restrictions ->|<--------------------| |
| removed | | |
Figure 6: Optional Graceful Service Termination Procedure
<span class="grey">Bertz, et al. Standards Track [Page 36]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
In addition, the credit-control server MAY reply with the Final-Unit-
Indication AVP or QoS-Final-Unit-Indication AVP holding a Granted-
Service-Unit (G-S-U) with a zero grant, indicating that the service
SHOULD be terminated immediately, and no further reporting is
required. Figure 7 illustrates a graceful service termination
procedure that applies immediately after receiving a zero grant.
Diameter
End User Service Element AAA Server CC Server
(CC Client)
| Service Delivery | | |
|<----------------->| | |
| |CCR(Update, Used-Units) |
| |--------------------->|CCR(Update, Used-Units)
| : | |-------------------->|
| : | |CCA(Final-Unit, Action,
| : | | Zero G-S-U)
| : | |<--------------------|
| |CCA(Final-Unit, Action, |
| | Zero G-S-U) |
| |<---------------------| |
| /////////////// | | |
|/Action and // | | |
|/Restrictions // | | |
|/Start // | | |
| ///////////// | | |
| : | | |
| : | | |
Figure 7: Optional Immediate Graceful Service Termination Procedure
<span class="h4"><a class="selflink" id="section-5.6.1" href="#section-5.6.1">5.6.1</a>. Terminate Action</span>
The Final-Unit-Indication AVP or the QoS-Final-Unit-Indication AVP
with Final-Unit-Action set to TERMINATE does not include any other
information. When the subscriber has consumed the final granted
units, the Service Element MUST terminate the service. This is the
default handling applicable whenever the credit-control client
receives an unsupported Final-Unit-Action value and MUST be supported
by all the Diameter Credit-Control client implementations conforming
to this specification. A final Credit-Control-Request message to the
credit-control server MUST be sent if the Final-Unit-Indication AVP
or the QoS-Final-Unit-Indication AVP indicating action TERMINATE was
present at the command level. The CC-Request-Type AVP in the request
is set to the value TERMINATION_REQUEST.
<span class="grey">Bertz, et al. Standards Track [Page 37]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h4"><a class="selflink" id="section-5.6.2" href="#section-5.6.2">5.6.2</a>. Redirect Action</span>
The Final-Unit-Indication AVP or the QoS-Final-Unit-Indication AVP
with Final-Unit-Action set to REDIRECT indicates to the Service
Element supporting this action that, upon consumption of the final
granted units, the user MUST be redirected to the address specified
in the Redirect-Server AVP or Redirect-Server-Extension AVP as
follows.
The credit-control server sends the Redirect-Server AVP or Redirect-
Server-Extension AVP in the Credit-Control-Answer message. In such a
case, the Service Element MUST redirect or connect the user to the
destination specified in the Redirect-Server AVP or Redirect-Server-
Extension AVP, if possible. When the end user is redirected (by
using protocols other than Diameter) to the specified server or
connected to the top-up server, an additional authorization (and
possibly authentication) may be needed before the subscriber can
replenish the account; however, this scenario is out of scope for
this specification.
In addition to the Redirect-Server AVP or Redirect-Server-Extension
AVP, the credit-control server MAY include one or more Restriction-
Filter-Rule AVPs, one or more Filter-Rule AVPs, or one or more
Filter-Id AVPs in the Credit-Control-Answer message to enable the
user to access other services (for example, zero-rated services). In
such a case, the access device MUST treat all packets according to
the Restriction-Filter-Rule AVPs, Filter-Rule AVPs, and the rules
referred to by the Filter-Id AVP. After treatment is applied
according to these rules, all traffic that has not been dropped or
already forwarded MUST be redirected to the destination specified in
the Redirect-Server AVP or Redirect-Server-Extension AVP.
An entity other than the credit-control server may provision the
access device with appropriate IP packet filters to be used in
conjunction with the Diameter Credit-Control application. This case
is considered in <a href="#section-5.6.3">Section 5.6.3</a>.
When the final granted units have been consumed, the credit-control
client MUST perform an intermediate interrogation. The purpose of
this interrogation is to indicate to the credit-control server that
the specified action started and to report the used units. The
credit-control server MUST deduct the used amount from the end user's
account but MUST NOT make a new credit reservation. The
credit-control client, however, may send intermediate interrogations
before all the final granted units have been consumed for which
rating and money reservation may be needed -- for instance, upon
Validity-Time expiration or upon mid-session service events that
affect the rating of the current service. Therefore, the
<span class="grey">Bertz, et al. Standards Track [Page 38]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
credit-control client MUST NOT include any rating-related AVPs in the
request sent once all the final granted units have been consumed, as
an indication to the server that (1) the requested final unit action
started and (2) rating and money reservation are not required (when
the Multiple-Services-Credit-Control AVP is used, the Service-
Identifier AVP or the Rating-Group AVP is included to indicate the
services concerned). Naturally, the Credit-Control-Answer message
does not contain any granted service units and MUST include the
Validity-Time AVP to indicate to the credit-control client how long
the subscriber is allowed to use network resources before a new
intermediate interrogation is sent to the server.
At the expiry of Validity-Time, the credit-control client sends a
Credit-Control-Request (UPDATE_REQUEST) as usual. This message does
not include the Used-Service-Unit AVP, as there is no allotted quota
to report. The credit-control server processes the request and MUST
perform the credit reservation. If during this time the subscriber
did not replenish their account, whether they will be disconnected or
will be granted access to services not controlled by a credit-control
server for an unlimited time is dependent on the home service
provider policy. (Note: The latter option implies that the Service
Element should not remove the restriction filters upon termination of
the credit-control.) The server will return the appropriate
Result-Code (see <a href="#section-9.1">Section 9.1</a>) in the Credit-Control-Answer message in
order to implement the policy-defined action. Otherwise, a new quota
will be returned, and the Service Element MUST remove all the
possible restrictions activated by the graceful service termination
process and continue the credit-control session and service session
as usual.
The credit-control client may not wait until the expiration of the
Validity-Time and may send a spontaneous update (a new
Credit-Control-Request) if the Service Element can determine, for
instance, that communication between the end user and the top-up
server took place. An example of this case is given in <a href="#appendix-A.8">Appendix A.8</a>
(Figure 18).
Note that the credit-control server may already have initiated the
above-described process for the first interrogation. However, the
user's account might be empty when this first interrogation is
performed. In this case, the subscriber can be offered a chance to
replenish the account and continue the service. When the
credit-control client receives (at either the session level or a
service-specific level) a Final-Unit-Indication AVP or QoS-Final-
Unit-Indication AVP, together with Validity-Time AVPs, but without a
Granted-Service-Unit AVP, it immediately starts the graceful service
termination process without sending any messages to the server. An
example of this case is illustrated in <a href="#appendix-A.8">Appendix A.8</a> (Figure 18).
<span class="grey">Bertz, et al. Standards Track [Page 39]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h4"><a class="selflink" id="section-5.6.3" href="#section-5.6.3">5.6.3</a>. Restrict Access Action</span>
A Final-Unit-Indication AVP with Final-Unit-Action set to
RESTRICT_ACCESS indicates to the device supporting this action that,
upon consumption of the final granted units, the user's access MUST
be restricted according to the IP packet filters given in the
Restriction-Filter-Rule AVP(s) or according to the IP packet filters
identified by the Filter-Id AVP(s). The credit-control server SHOULD
include either the Restriction-Filter-Rule AVP or the Filter-Id AVP
in the Final-Unit-Indication group AVP of the Credit-Control-Answer
message.
A QoS-Final-Unit-Indication AVP with Final-Unit-Action set to
RESTRICT_ACCESS indicates to the device supporting this action that,
upon consumption of the final granted units, the actions specified in
Filter-Rule AVP(s) MUST restrict the traffic according to the
classifiers in the Filter-Rule AVP(s). If one or more Filter-Id AVPs
are provided in the Credit-Control-Answer message, the credit-control
client MUST restrict the traffic according to the IP packet filters
identified by the Filter-Id AVP(s). The credit-control server SHOULD
include either the Filter-Rule AVP or the Filter-Id AVP in the
QoS-Final-Unit-Indication group AVP of the Credit-Control-Answer
message.
If both the Final-Unit-Indication AVP and the QoS-Final-Unit-
Indication AVP exist in the Credit-Control-Answer message, a
credit-control client that supports the QoS-Final-Unit-Indication AVP
SHOULD follow the directives included in the QoS-Final-Unit-
Indication AVP and SHOULD ignore the Final-Unit-Indication AVP.
An entity other than the credit-control server may provision the
access device with appropriate IP packet filters to be used in
conjunction with the Diameter Credit-Control application. Such an
entity may, for instance, configure the access device with IP flows
to be passed when the Diameter Credit-Control application indicates
RESTRICT_ACCESS or REDIRECT. The access device passes IP packets
according to the filter rules that may have been received in the
Credit-Control-Answer message, in addition to those rules that may
have been configured by the other entity. However, when the user's
account cannot cover the cost of the requested service, the action
taken is the responsibility of the credit-control server that
controls the prepaid subscriber.
If another entity working in conjunction with the Diameter
Credit-Control application already provisions the access device with
all the required filter rules for the end user, the credit-control
server presumably need not send any additional filters. Therefore,
it is RECOMMENDED that credit-control server implementations
<span class="grey">Bertz, et al. Standards Track [Page 40]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
supporting graceful service termination be configurable for sending
the Restriction-Filter-Rule AVP, the Filter-Rule AVP, the Filter-Id
AVP, or none of the above.
When the final granted units have been consumed, the credit-control
client MUST perform an intermediate interrogation. The
credit-control client and the credit-control server process this
intermediate interrogation and execute subsequent procedures, as
specified in <a href="#section-5.6.2">Section 5.6.2</a>.
The credit-control server may initiate graceful service termination
when replying with the action RESTRICT_ACCESS for the first
interrogation. This is similar to the behavior specified in
<a href="#section-5.6.2">Section 5.6.2</a>.
<span class="h4"><a class="selflink" id="section-5.6.4" href="#section-5.6.4">5.6.4</a>. Usage of the Server-Initiated Credit Re-authorization</span>
Once the subscriber replenishes the account, they presumably expect
all the restrictions applied by the graceful service termination
procedure to be removed immediately and unlimited service access to
be resumed. For the best user experience, the credit-control server
implementation MAY support the server-initiated credit
re-authorization (see <a href="#section-5.5">Section 5.5</a>). In such a case, upon the
successful account top-up, the credit-control server sends the
Re-Auth-Request (RAR) message to solicit the credit re-authorization.
The credit-control client initiates the credit re-authorization by
sending the Credit-Control-Request message with the CC-Request-Type
AVP set to the value UPDATE_REQUEST. The Used-Service-Unit AVP is
not included in the request, as there is no allotted quota to report.
The Requested-Service-Unit AVP MAY be included in the request. After
the credit-control client successfully receives the Credit-Control-
Answer with a new Granted-Service-Unit AVP, all the possible
restrictions activated for the purpose of graceful service
termination MUST be removed in the Service Element. The
credit-control session and the service session continue as usual.
<span class="h3"><a class="selflink" id="section-5.7" href="#section-5.7">5.7</a>. Failure Procedures</span>
The CCFH, as described in this section, determines the behavior of
the credit-control client in fault situations. The CCFH may be
(1) received from the Diameter home AAA server, (2) received from the
credit-control server, or (3) configured locally. The CCFH value
received from the home AAA server overrides the locally configured
value. The CCFH value received from the credit-control server in the
Credit-Control-Answer message always overrides any existing values.
<span class="grey">Bertz, et al. Standards Track [Page 41]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-42" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
The authorization server MAY include the Accounting-Realtime-Required
AVP to determine what to do if the sending of accounting records to
the accounting server has been temporarily prevented, as defined in
[<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]. It is RECOMMENDED that the client complement the
credit-control failure procedures with a backup accounting flow
toward an accounting server. By using different combinations of the
Accounting-Realtime-Required AVP and the CCFH, different safety
levels can be built. For example, by choosing a CCFH equal to
CONTINUE for the credit-control flow and an Accounting-Realtime-
Required AVP equal to DELIVER_AND_GRANT for the accounting flow, the
service can be granted to the end user even if the connection to the
credit-control server is down, as long as the accounting server is
able to collect the accounting information and information exchange
is taking place between the accounting server and credit-control
server.
As the credit-control application is based on real-time bidirectional
communication between the credit-control client and the
credit-control server, the usage of alternative destinations and the
buffering of messages may not be sufficient in the event of
communication failures. Because the credit-control server has to
maintain session states, moving the credit-control message stream to
a backup server requires a complex context transfer solution.
Whether the credit-control message stream is moved to a backup
credit-control server during an ongoing credit-control session
depends on the value of the CC-Session-Failover AVP. However,
failover may occur at any point in the path between the
credit-control client and the credit-control server if a transport
failure is detected with a peer, as described in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]. As a
consequence, the credit-control server might receive duplicate
messages. These duplicate or out-of-sequence messages can be
detected in the credit-control server based on the credit-control
server session state machine (<a href="#section-7">Section 7</a>), Session-Id AVP, and
CC-Request-Number AVP.
If a failure occurs during an ongoing credit-control session, the
credit-control client may move the credit-control message stream to
an alternative server if the credit-control server indicated
FAILOVER_SUPPORTED in the CC-Session-Failover AVP. A secondary
credit-control server name, either received from the home Diameter
AAA server or configured locally, can be used as an address of the
backup server. If the CC-Session-Failover AVP is set to
FAILOVER_NOT_SUPPORTED, the credit-control message stream MUST NOT be
moved to a backup server.
<span class="grey">Bertz, et al. Standards Track [Page 42]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-43" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
For new credit-control sessions, failover to an alternative
credit-control server SHOULD be performed, if possible. For
instance, if an implementation of the credit-control client can
determine primary credit-control server unavailability, it can
establish the new credit-control sessions with a possibly available
secondary credit-control server.
The AAA transport profile [<a href="./rfc3539" title=""Authentication, Authorization and Accounting (AAA) Transport Profile"">RFC3539</a>] defines an application-layer
watchdog algorithm that enables failover from a peer that has failed
and is controlled by a watchdog timer (Tw) (defined in [<a href="./rfc3539" title=""Authentication, Authorization and Accounting (AAA) Transport Profile"">RFC3539</a>]).
The recommended default initial value for Tw (Twinit) is 30 seconds.
Twinit may be set as low as 6 seconds; however, according to
[<a href="./rfc3539" title=""Authentication, Authorization and Accounting (AAA) Transport Profile"">RFC3539</a>], setting too low a value for Twinit is likely to result in
an increased probability of duplicates, as well as an increase in
spurious failover and failback attempts. The Diameter base protocol
[<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>] is common to several different types of Diameter AAA
applications that may be run in the same Service Element. Therefore,
tuning the timer for Twinit to a lower value in order to satisfy the
requirements of real-time applications, such as the Diameter
Credit-Control application, will certainly cause the above-mentioned
problems. For prepaid services, however, the end user expects an
answer from the network in a reasonable time. Thus, the Diameter
Credit-Control client will react more quickly than would the
underlying base protocol. Therefore, this specification defines the
Tx timer (as defined in <a href="#section-13">Section 13</a>), which is used by the
credit-control client to supervise communication with the
credit-control server. When the Tx timer elapses, the credit-control
client takes action for the end user according to the CCFH.
When the Tx timer expires, the Diameter Credit-Control client always
terminates the service if the CCFH is set to the value TERMINATE.
The credit-control session may be moved to an alternative server only
if a protocol error DIAMETER_TOO_BUSY or DIAMETER_UNABLE_TO_DELIVER
is received before the Tx timer expires. Therefore, the value
TERMINATE is not appropriate if proper failover behavior is desired.
If the CCFH is set to the value CONTINUE or RETRY_AND_TERMINATE, the
service will be granted to the end user when the Tx timer expires.
An Answer message with granted units may arrive later if the base
protocol transport failover occurred in the path to the
credit-control server. (The Twinit default value is 3 times more
than the recommended Tx timeout value.) The credit-control client
SHOULD grant the service to the end user, start monitoring resource
usage, and wait for the possible late answer until the timeout of the
request (e.g., 120 seconds). If the request fails and the
CC-Session-Failover AVP is set to FAILOVER_NOT_SUPPORTED, the
<span class="grey">Bertz, et al. Standards Track [Page 43]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-44" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
credit-control client terminates or continues the service --
depending on the value set in the CCFH -- and MUST free all the
reserved resources for the credit-control session. If the protocol
error DIAMETER_UNABLE_TO_DELIVER or DIAMETER_TOO_BUSY is received or
the request times out and the CC-Session-Failover AVP is set to
FAILOVER_SUPPORTED, the credit-control client MAY send the request to
a backup server, if possible. If the credit-control client receives
a successful answer from the backup server, it continues the
credit-control session with such a server. If the retransmitted
request also fails, the credit-control client terminates or continues
the service -- depending on the value set in the CCFH -- and MUST
free all the reserved resources for the credit-control session.
If a communication failure occurs during the graceful service
termination procedure, the Service Element SHOULD always terminate
the ongoing service session.
If the credit-control server detects a failure during an ongoing
credit-control session, it will terminate the credit-control session
and return the reserved units back to the end user's account.
The supervision session timer Tcc (as defined in <a href="#section-13">Section 13</a>) is used
in the credit-control server to supervise the credit-control session.
In order to support failover between credit-control servers,
information transfer about the credit-control session and account
state SHOULD take place between the primary and secondary
credit-control servers. Implementations supporting credit-control
session failover MUST also ensure proper detection of duplicate or
out-of-sequence messages. Communication between the servers is
regarded as an implementation issue and is outside the scope of this
specification.
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. One-Time Event</span>
The one-time event is used when there is no need to maintain any
state in the Diameter Credit-Control server -- for example, inquiring
about the price of the service. The use of a one-time event implies
that the user has been authenticated and authorized beforehand.
<span class="grey">Bertz, et al. Standards Track [Page 44]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-45" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
The one-time event can be used when the credit-control client wants
to know the cost of the service event or to check the account balance
without any credit reservations. It can also be used for refunding
service units on the user's account or for direct debiting without
any credit reservations. The one-time event is shown in Figure 8.
Diameter
End User Service Element AAA Server CC Server
(CC Client)
| Service Request | | |
|------------------>| | |
| | CCR(Event) | |
| |------------------->| CCR(Event) |
| | |------------------->|
| | | CCA(Granted-Units)|
| | CCA(Granted-Units)|<-------------------|
| Service Delivery |<-------------------| |
|<----------------->| | |
Figure 8: One-Time Event
In environments such as the 3GPP architecture, the one-time event can
be sent from the Service Element directly to the credit-control
server.
<span class="h3"><a class="selflink" id="section-6.1" href="#section-6.1">6.1</a>. Service Price Inquiry</span>
The credit-control client may need to know the price of the service
event. Services offered by application service providers whose
prices are not known in the credit-control client might exist. The
end user might also want to get an estimate of the price of a service
event before requesting it.
A Diameter Credit-Control client requesting the cost information MUST
set the CC-Request-Type AVP equal to EVENT_REQUEST, include the
Requested-Action AVP set to PRICE_ENQUIRY, and set the requested
service event information in the Service-Identifier AVP in the
Credit-Control-Request message. Additional service event information
may be sent as service-specific AVPs or within the Service-Parameter-
Info AVP. The Service-Context-Id AVP indicates the service-specific
document applicable to the request.
The credit-control server calculates the cost of the requested
service event, but it does not perform any account-balance checks or
credit reservations from the account.
<span class="grey">Bertz, et al. Standards Track [Page 45]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-46" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
The estimated cost of the requested service event is returned to the
credit-control client in the Cost-Information AVP in the
Credit-Control-Answer message.
<span class="h3"><a class="selflink" id="section-6.2" href="#section-6.2">6.2</a>. Balance Checks</span>
The Diameter Credit-Control client may only have to verify that the
end user's account balance covers the cost of a certain service
without reserving any units from the account at the time of the
inquiry. This method does not guarantee that credit would be left
when the Diameter Credit-Control client requests the debiting of the
account with a separate request.
A Diameter Credit-Control client requesting a balance check MUST set
the CC-Request-Type AVP equal to EVENT_REQUEST, include a Requested-
Action AVP set to CHECK_BALANCE, and include the Subscription-Id AVP
or Subscription-Id-Extension AVP in order to identify the end user in
the credit-control server. The Service-Context-Id AVP indicates the
service-specific document applicable to the request.
The credit-control server makes the balance check, but it does not
make any credit reservations from the account.
The result of the balance check (ENOUGH_CREDIT/NO_CREDIT) is returned
to the credit-control client in the Check-Balance-Result AVP in the
Credit-Control-Answer message.
<span class="h3"><a class="selflink" id="section-6.3" href="#section-6.3">6.3</a>. Direct Debiting</span>
There are certain service events for which service execution is
always successful in the service environment. The delay between the
service invocation and the actual service delivery to the end user
can be sufficiently long that the use of session-based credit-control
would lead to unreasonably long credit-control sessions. In these
cases, the Diameter Credit-Control client can use the one-time event
scenario for direct debiting. The Diameter Credit-Control client
SHOULD be sure that the requested service event execution would be
successful when this scenario is used.
In the Credit-Control-Request message, the CC-Request-Type AVP is set
to the value EVENT_REQUEST and the Requested-Action AVP is set to
DIRECT_DEBITING. The Subscription-Id AVP or Subscription-Id-
Extension AVP SHOULD be included to identify the end user in the
credit-control server. The Event-Timestamp AVP SHOULD be included in
the request and contain the time when the service event is requested
in the Service Element. The Service-Context-Id AVP indicates the
service-specific document applicable to the request.
<span class="grey">Bertz, et al. Standards Track [Page 46]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-47" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
If it knows the cost of the service event, the Diameter
Credit-Control client MAY include in the Requested-Service-Unit AVP
the monetary amount to be charged. If the Diameter Credit-Control
client does not know the cost of the service event, the Requested-
Service-Unit AVP MAY contain the number of requested service events.
The Service-Identifier AVP always indicates the service concerned.
Additional service event information to be rated MAY be sent as
service-specific AVPs or within the Service-Parameter-Info AVP.
The credit-control server SHOULD rate the service event and deduct
the corresponding monetary amount from the end user's account. If
the type of the Requested-Service-Unit AVP is "money", no rating is
needed, but the corresponding monetary amount is deducted from the
end user's account.
The credit-control server returns the Granted-Service-Unit AVP in the
Credit-Control-Answer message to the Diameter Credit-Control client.
The Granted-Service-Unit AVP contains the amount of service units
that the Diameter Credit-Control client can provide to the end user.
The type of the Granted-Service-Unit can be time, volume, service-
specific, or money, depending on the type of service event.
If the credit-control server determines that no credit-control is
needed for the service, it can include the result code indicating
that the credit-control is not applicable (e.g., the service is free
of charge).
For informative purposes, the Credit-Control-Answer message MAY also
include the Cost-Information AVP containing the estimated total cost
of the requested service.
<span class="h3"><a class="selflink" id="section-6.4" href="#section-6.4">6.4</a>. Refunds</span>
Some services may refund service units to the end user's account --
for example, gaming services.
The credit-control client MUST set the CC-Request-Type AVP to the
value EVENT_REQUEST and the Requested-Action AVP to REFUND_ACCOUNT in
the Credit-Control-Request message. The Subscription-Id AVP or
Subscription-Id-Extension AVP SHOULD be included to identify the
end user in the credit-control server. The Service-Context-Id AVP
indicates the service-specific document applicable to the request.
The Diameter Credit-Control client MAY include the monetary amount to
be refunded in the Requested-Service-Unit AVP. The Service-
Identifier AVP always indicates the service concerned. If the
Diameter Credit-Control client does not know the monetary amount to
<span class="grey">Bertz, et al. Standards Track [Page 47]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-48" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
be refunded, in addition to the Service-Identifier AVP it MAY send
service-specific AVPs or the Service-Parameter-Info AVP containing
additional service event information to be rated.
For informative purposes, the Credit-Control-Answer message MAY also
include the Cost-Information AVP containing the estimated monetary
amount of refunded units.
<span class="h3"><a class="selflink" id="section-6.5" href="#section-6.5">6.5</a>. Failure Procedure</span>
Failover to an alternative credit-control server is allowed for a
one-time event, as the server is not maintaining session states. For
instance, if the credit-control client receives a protocol error
DIAMETER_UNABLE_TO_DELIVER or DIAMETER_TOO_BUSY, it can resend the
request to an alternative server, if possible. There MAY be
protocol-transparent Diameter relays and redirect agents or Diameter
Credit-Control proxies between the credit-control client and
credit-control server. Failover may occur at any point in the path
between the credit-control client and the credit-control server if a
transport failure is detected with a peer, as described in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>].
Because there can be duplicate requests for various reasons, the
credit-control server is responsible for real-time duplicate
detection. Implementation issues for duplicate detection are
discussed in <a href="./rfc6733#appendix-C">[RFC6733], Appendix C</a>.
When the credit-control client detects a communication failure with
the credit-control server, its behavior depends on the requested
action. The Tx timer (as defined in <a href="#section-13">Section 13</a>) is used in the
credit-control client to supervise communication with the
credit-control server.
If the requested action is PRICE_ENQUIRY or CHECK_BALANCE and a
communication failure is detected, the credit-control client SHOULD
forward the request messages to an alternative credit-control server,
if possible. The secondary credit-control server name, if received
from the home Diameter AAA server, can be used as an address of the
backup server.
If the requested action is DIRECT_DEBITING, the DDFH controls the
credit-control client's behavior. The DDFH may be received from the
home Diameter AAA server or may be locally configured. The
credit-control server may also send the DDFH in any CCA messages to
be used for direct-debiting events compiled thereafter. The DDFH
value received from the home Diameter AAA server overrides the
locally configured value, and the DDFH value received from the
credit-control server in a Credit-Control-Answer message always
overrides any existing values.
<span class="grey">Bertz, et al. Standards Track [Page 48]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-49" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
If the DDFH is set to TERMINATE_OR_BUFFER, the credit-control client
SHOULD NOT grant the service if, after a possible retransmission
attempt to an alternative credit-control server, the credit-control
client can eventually determine from the result code or error code in
the Answer message that units have not been debited. Otherwise, the
credit-control client SHOULD grant the service to the end user and
store the request in credit-control application-level non-volatile
storage. (Note that resending the request at a later time is not a
guarantee that the service will be debited, as the user's account may
be empty when the server successfully processes the request.) The
credit-control client MUST mark these request messages as possible
duplicates by setting the T flag in the command header as described
in <a href="./rfc6733#section-3">[RFC6733], Section 3</a>.
If the DDFH is set to CONTINUE, the service SHOULD be granted, even
if credit-control messages cannot be delivered and messages are not
buffered.
If the Tx timer expires, the credit-control client MUST continue the
service and wait for a possible late answer. If the request
times out, the credit-control client retransmits the request (marked
with the T flag) to a backup credit-control server, if possible. If
the retransmitted request also times out or if a temporary error is
received in answer, the credit-control client buffers the request if
the value of the DDFH is set to TERMINATE_OR_BUFFER. If a failed
answer is received for the retransmitted request, the credit-control
client frees all the resources reserved for the event message and
deletes the request regardless of the value of the DDFH.
The Credit-Control-Request with the requested action REFUND_ACCOUNT
should always be stored in credit-control application-level
non-volatile storage in case a temporary failure occurs. The
credit-control client MUST mark the retransmitted request message as
a possible duplicate by setting the T flag in the command header as
described in <a href="./rfc6733#section-3">[RFC6733], Section 3</a>.
For stored requests, the implementation may choose to limit the
number of retransmission attempts and to define a retransmission
interval.
Note that only one entity in the credit-control system SHOULD be
responsible for duplicate detection. If there is only one
credit-control server within the given realm, the credit-control
server may perform duplicate detection. If there is more than one
credit-control server in a given realm, only one entity in the
credit-control system should be responsible, to ensure that the
end user's account is not debited or credited multiple times for the
same service event.
<span class="grey">Bertz, et al. Standards Track [Page 49]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-50" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Credit-Control Application State Machines</span>
This section defines five credit-control application state machines.
The first four state machines are to be observed by credit-control
clients.
The first state machine describes session-based credit-control where
the first interrogation is executed as part of the authorization/
authentication process. The second state machine describes
session-based credit-control where the first interrogation is
executed after the authorization/authentication process. The
requirements regarding what has to be supported for these two state
machines are discussed in <a href="#section-5.2">Section 5.2</a>.
The third state machine describes session-based credit-control for
the intermediate and final interrogations. The fourth state machine
describes event-based credit-control. These two state machines are
to be observed by all implementations that conform to this
specification.
The fifth state machine describes the credit-control session from a
credit-control server's perspective.
Any event not listed in the state machines MUST be considered an
error condition, and a corresponding answer, if applicable, MUST be
returned to the originator of the message.
In Tables 3, 4, and 5, the event "failure to send" means that the
Diameter Credit-Control client is unable to communicate with the
desired destination or, if a failover procedure is supported, with a
possibly defined alternative destination (e.g., the request times out
and the Answer message is not received). This could be due to
(1) the peer being down or (2) a physical link failure in the path to
or from the credit-control server.
The event "temporary error" means that the Diameter Credit-Control
client received a protocol error notification (DIAMETER_TOO_BUSY,
DIAMETER_UNABLE_TO_DELIVER, or DIAMETER_LOOP_DETECTED) in the
Result-Code AVP of the Credit-Control-Answer command. This type of
notification may ultimately be received in answer to the
retransmitted request to a defined alternative destination, if
failover is supported.
<span class="grey">Bertz, et al. Standards Track [Page 50]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-51" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
The event "failed answer" means that the Diameter Credit-Control
client received a non-transient failure (permanent failure)
notification in the Credit-Control-Answer command. This type of
notification may ultimately be received in answer to the
retransmitted request to a defined alternative destination, if
failover is supported.
The action "store request" means that a request is stored in
credit-control application-level non-volatile storage.
The event "not successfully processed" means that the credit-control
server could not process the message, e.g., due to an unknown
end user, an account being empty, or errors defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>].
The event "user service terminated" can be triggered for various
reasons, e.g., normal user termination, network failure, and ASR
(Abort-Session-Request). The Termination-Cause AVP contains
information about the reason for termination, as specified in
[<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>].
The Tx timer, which is used to control the waiting time in the
credit-control client in the Pending state, is stopped upon exit of
the Pending state. The stopping of the Tx timer is omitted in the
state machine when the new state is Idle, as moving to Idle state
implies the clearing of the session and all the variables associated
to it.
The states PendingI, PendingU, PendingT, PendingE, and PendingB stand
for pending states to wait for an answer to a credit-control request
related to Initial, Update, Termination, Event, or Buffered request,
respectively.
In Table 2, failover to a secondary server upon "temporary error" or
"failure to send" is not explicitly described. However, moving an
ongoing credit-control message stream to an alternative server is
possible if the CC-Session-Failover AVP is set to FAILOVER_SUPPORTED,
as described in <a href="#section-5.7">Section 5.7</a>.
Resending a credit-control event to an alternative server is
supported as described in <a href="#section-6.5">Section 6.5</a>.
<span class="grey">Bertz, et al. Standards Track [Page 51]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-52" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
+----------+-------------------------------+-------------+----------+
| State | Event | Action | New |
| | | | State |
+----------+-------------------------------+-------------+----------+
| Idle | Client or device requests | Send | PendingI |
| | access/service | AA-Request | |
| | | with added | |
| | | CC AVPs, | |
| | | start Tx | |
| | | timer | |
| | | | |
| PendingI | Successful answer to | Grant | Open |
| | AA-Request received | service to | |
| | | end user, | |
| | | stop Tx | |
| | | timer | |
| | | | |
| PendingI | Tx timer expired | Disconnect | Idle |
| | | user/dev | |
| | | | |
| PendingI | Failed AA-Answer received | Disconnect | Idle |
| | | user/dev | |
| | | | |
| PendingI | AA-Answer received with | Grant | Idle |
| | Result-Code equal to | service to | |
| | CREDIT_CONTROL_NOT_APPLICABLE | end user | |
| | | | |
| PendingI | User service terminated | Queue | PendingI |
| | | termination | |
| | | event | |
| | | | |
| PendingI | Change in rating condition | Queue | PendingI |
| | | changed | |
| | | rating | |
| | | condition | |
| | | event | |
+----------+-------------------------------+-------------+----------+
Table 2: Session-Based Client State Machine for the
First Interrogation with AA-Request
<span class="grey">Bertz, et al. Standards Track [Page 52]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-53" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
+----------+-------------------------------+-------------+----------+
| State | Event | Action | New |
| | | | State |
+----------+-------------------------------+-------------+----------+
| Idle | Client or device requests | Send CC | PendingI |
| | access/service | initial | |
| | | req., start | |
| | | Tx timer | |
| | | | |
| PendingI | Successful CC initial answer | Stop Tx | Open |
| | received | timer | |
| | | | |
| PendingI | Failure to send, or temporary | Grant | Idle |
| | error and CCFH equal to | service to | |
| | CONTINUE | end user | |
| | | | |
| PendingI | Failure to send, or temporary | Terminate | Idle |
| | error and CCFH equal to | end user's | |
| | TERMINATE or to | service | |
| | RETRY_AND_TERMINATE | | |
| | | | |
| PendingI | Tx timer expired and CCFH | Terminate | Idle |
| | equal to TERMINATE | end user's | |
| | | service | |
| | | | |
| PendingI | Tx timer expired and CCFH | Grant | PendingI |
| | equal to CONTINUE or to | service to | |
| | RETRY_AND_TERMINATE | end user | |
| | | | |
| PendingI | CC initial answer received | Terminate | Idle |
| | with Result-Code equal to | end user's | |
| | END_USER_SERVICE_DENIED or to | service | |
| | USER_UNKNOWN | | |
| | | | |
| PendingI | CC initial answer received | Grant | Idle |
| | with Result-Code equal to | service to | |
| | CREDIT_CONTROL_NOT_APPLICABLE | end user | |
| | | | |
| PendingI | Failed CC initial answer | Grant | Idle |
| | received and CCFH equal to | service to | |
| | CONTINUE | end user | |
| | | | |
| PendingI | Failed CC initial answer | Terminate | Idle |
| | received and CCFH equal to | end user's | |
| | TERMINATE or to | service | |
| | RETRY_AND_TERMINATE | | |
| | | | |
<span class="grey">Bertz, et al. Standards Track [Page 53]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-54" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
| PendingI | User service terminated | Queue | PendingI |
| | | termination | |
| | | event | |
| | | | |
| PendingI | Change in rating condition | Queue | PendingI |
| | | changed | |
| | | rating | |
| | | condition | |
| | | event | |
+----------+-------------------------------+-------------+----------+
Table 3: Session-Based Client State Machine for the
First Interrogation with CCR
+----------+-------------------------------+-------------+----------+
| State | Event | Action | New |
| | | | State |
+----------+-------------------------------+-------------+----------+
| Open | Granted unit elapses and no | Send CC | PendingU |
| | final-unit indication | update | |
| | received | req., start | |
| | | Tx timer | |
| | | | |
| Open | Granted unit elapses and | Terminate | PendingT |
| | final unit action equal to | end user's | |
| | TERMINATE received | service, | |
| | | send CC | |
| | | termination | |
| | | req. | |
| | | | |
| Open | Change in rating condition in | Send CC | PendingU |
| | queue | update | |
| | | req., start | |
| | | Tx timer | |
| | | | |
| Open | Service terminated in queue | Send CC | PendingT |
| | | termination | |
| | | req. | |
| | | | |
| Open | Change in rating condition or | Send CC | PendingU |
| | Validity-Time elapses | update | |
| | | req., start | |
| | | Tx timer | |
| | | | |
| Open | User service terminated | Send CC | PendingT |
| | | termination | |
| | | req. | |
<span class="grey">Bertz, et al. Standards Track [Page 54]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-55" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
| | | | |
| Open | RAR received | Send RAA | PendingU |
| | | followed by | |
| | | CC update | |
| | | req., start | |
| | | Tx timer | |
| | | | |
| PendingU | Successful CC update answer | Stop Tx | Open |
| | received | timer | |
| | | | |
| PendingU | Failure to send, or temporary | Grant | Idle |
| | error and CCFH equal to | service to | |
| | CONTINUE | end user | |
| | | | |
| PendingU | Failure to send, or temporary | Terminate | Idle |
| | error and CCFH equal to | end user's | |
| | TERMINATE or to | service | |
| | RETRY_AND_TERMINATE | | |
| | | | |
| PendingU | Tx timer expired and CCFH | Terminate | Idle |
| | equal to TERMINATE | end user's | |
| | | service | |
| | | | |
| PendingU | Tx timer expired and CCFH | Grant | PendingU |
| | equal to CONTINUE or to | service to | |
| | RETRY_AND_TERMINATE | end user | |
| | | | |
| PendingU | CC update answer received | Terminate | Idle |
| | with Result-Code equal to | end user's | |
| | END_USER_SERVICE_DENIED | service | |
| | | | |
| PendingU | CC update answer received | Grant | Idle |
| | with Result-Code equal to | service to | |
| | CREDIT_CONTROL_NOT_APPLICABLE | end user | |
| | | | |
| PendingU | Failed CC update answer | Grant | Idle |
| | received and CCFH equal to | service to | |
| | CONTINUE | end user | |
| | | | |
| PendingU | Failed CC update answer | Terminate | Idle |
| | received and CCFH equal to | end user's | |
| | TERMINATE or to | service | |
| | RETRY_AND_TERMINATE | | |
| | | | |
| PendingU | User service terminated | Queue | PendingU |
| | | termination | |
| | | event | |
| | | | |
<span class="grey">Bertz, et al. Standards Track [Page 55]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-56" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
| PendingU | Change in rating condition | Queue | PendingU |
| | | changed | |
| | | rating | |
| | | condition | |
| | | event | |
| | | | |
| PendingU | RAR received | Send RAA | PendingU |
| | | | |
| PendingT | Successful CC termination | | Idle |
| | answer received | | |
| | | | |
| PendingT | Failure to send, temporary | | Idle |
| | error, or failed answer | | |
| | | | |
| PendingT | Change in rating condition | | PendingT |
+----------+-------------------------------+-------------+----------+
Table 4: Session-Based Client State Machine for Intermediate and
Final Interrogations
+----------+--------------------------------+------------+----------+
| State | Event | Action | New |
| | | | State |
+----------+--------------------------------+------------+----------+
| Idle | Client or device requests a | Send CC | PendingE |
| | one-time service | event | |
| | | req., | |
| | | start Tx | |
| | | timer | |
| | | | |
| Idle | Request in storage | Send | PendingB |
| | | stored | |
| | | request | |
| | | | |
| PendingE | Successful CC event answer | Grant | Idle |
| | received | service to | |
| | | end user | |
| | | | |
| PendingE | Failure to send, temporary | Indicate | Idle |
| | error, failed CC event answer | service | |
| | received, or Tx timer expired; | error | |
| | requested action CHECK_BALANCE | | |
| | or PRICE_ENQUIRY | | |
| | | | |
<span class="grey">Bertz, et al. Standards Track [Page 56]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-57" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
| PendingE | CC event answer received with | Terminate | Idle |
| | Result-Code equal to | end user's | |
| | END_USER_SERVICE_DENIED or to | service | |
| | USER_UNKNOWN and Tx timer | | |
| | running | | |
| | | | |
| PendingE | CC event answer received with | Grant | Idle |
| | Result-Code equal to | service to | |
| | CREDIT_CONTROL_NOT_APPLICABLE; | end user | |
| | requested action | | |
| | DIRECT_DEBITING | | |
| | | | |
| PendingE | Failure to send, temporary | Grant | Idle |
| | error, or failed CC event | service to | |
| | answer received; requested | end user | |
| | action DIRECT_DEBITING; DDFH | | |
| | equal to CONTINUE | | |
| | | | |
| PendingE | Failed CC event answer | Terminate | Idle |
| | received or temporary error; | end user's | |
| | requested action | service | |
| | DIRECT_DEBITING; DDFH equal to | | |
| | TERMINATE_OR_BUFFER and Tx | | |
| | timer running | | |
| | | | |
| PendingE | Tx timer expired; requested | Grant | PendingE |
| | action DIRECT_DEBITING | service to | |
| | | end user | |
| | | | |
| PendingE | Failure to send; requested | Store | Idle |
| | action DIRECT_DEBITING; DDFH | request | |
| | equal to TERMINATE_OR_BUFFER | with | |
| | | T flag | |
| | | | |
| PendingE | Temporary error; requested | Store | Idle |
| | action DIRECT_DEBITING; DDFH | request | |
| | equal to TERMINATE_OR_BUFFER; | | |
| | Tx timer expired | | |
| | | | |
| PendingE | Failed answer or answer | | Idle |
| | received with Result-Code | | |
| | equal to END_USER_SERVICE | | |
| | DENIED or to USER_UNKNOWN; | | |
| | requested action | | |
| | DIRECT_DEBITING; Tx timer | | |
| | expired | | |
| | | | |
<span class="grey">Bertz, et al. Standards Track [Page 57]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-58" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
| PendingE | Failed CC event answer | Indicate | Idle |
| | received; requested action | service | |
| | REFUND_ACCOUNT | error and | |
| | | delete | |
| | | request | |
| | | | |
| PendingE | Failure to send or Tx timer | Store | Idle |
| | expired; requested action | request | |
| | REFUND_ACCOUNT | with | |
| | | T flag | |
| | | | |
| PendingE | Temporary error; requested | Store | Idle |
| | action REFUND_ACCOUNT | request | |
| | | | |
| PendingB | Successful CC answer received | Delete | Idle |
| | | request | |
| | | | |
| PendingB | Failed CC answer received | Delete | Idle |
| | | request | |
| | | | |
| PendingB | Failure to send or temporary | | Idle |
| | error | | |
+----------+--------------------------------+------------+----------+
Table 5: One-Time Event Client State Machine
+-------+------------------------+--------------------------+-------+
| State | Event | Action | New |
| | | | State |
+-------+------------------------+--------------------------+-------+
| Idle | CC initial request | Send CC initial answer, | Open |
| | received and | reserve units, start Tcc | |
| | successfully processed | | |
| | | | |
| Idle | CC initial request | Send CC initial answer | Idle |
| | received but not | with Result-Code != | |
| | successfully processed | SUCCESS | |
| | | | |
| Idle | CC event request | Send CC event answer | Idle |
| | received and | | |
| | successfully processed | | |
| | | | |
| Idle | CC event request | Send CC event answer | Idle |
| | received but not | with Result-Code != | |
| | successfully processed | SUCCESS | |
| | | | |
<span class="grey">Bertz, et al. Standards Track [Page 58]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-59" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
| Open | CC update request | Send CC update answer, | Open |
| | received and | debit used units, | |
| | successfully processed | reserve new units, | |
| | | restart Tcc | |
| | | | |
| Open | CC update request | Send CC update answer | Idle |
| | received but not | with Result-Code != | |
| | successfully processed | SUCCESS, debit used | |
| | | units | |
| | | | |
| Open | CC termination request | Send CC termin. answer, | Idle |
| | received and | stop Tcc, debit used | |
| | successfully processed | units | |
| | | | |
| Open | CC termination request | Send CC termin. answer | Idle |
| | received but not | with Result-Code != | |
| | successfully processed | SUCCESS, debit used | |
| | | units | |
| | | | |
| Open | Session supervision | Release reserved units | Idle |
| | timer Tcc expired | | |
+-------+------------------------+--------------------------+-------+
Table 6: Session-Based and Event-Based Server State Machine
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Credit-Control AVPs</span>
This section defines the Credit-Control AVPs that are specific to the
Diameter Credit-Control application and that MAY be included in the
Diameter Credit-Control messages.
The AVPs defined in this section MAY also be included in
authorization commands defined in authorization-specific
applications, such as [<a href="./rfc7155" title=""Diameter Network Access Server Application"">RFC7155</a>] and [<a href="./rfc4004" title=""Diameter Mobile IPv4 Application"">RFC4004</a>], if the first
interrogation is performed as part of the authorization/
authentication process, as described in <a href="#section-5.2">Section 5.2</a>.
The Diameter AVP rules are defined in <a href="./rfc6733#section-4">[RFC6733], Section 4</a>. These
AVP rules are observed in AVPs defined in this section.
The following table describes the Diameter AVPs defined in the
credit-control application, their AVP Code values, types, and
possible flag values. The AVP Flag rules ('M', 'V') are explained in
<a href="./rfc6733#section-4.1">[RFC6733], Section 4.1</a>.
<span class="grey">Bertz, et al. Standards Track [Page 59]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-60" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
+---------------+
|AVP Flag Rules |
Defined |----+-----+----|
AVP in | | |MUST|
Attribute Name Code Section Data Type |MUST| MAY |NOT |
----------------------------------------------------|----+-----+----|
CC-Correlation-Id 411 8.1 OctetString | | M | V |
CC-Input-Octets 412 8.24 Unsigned64 | M | | V |
CC-Money 413 8.22 Grouped | M | | V |
CC-Output-Octets 414 8.25 Unsigned64 | M | | V |
CC-Request-Number 415 8.2 Unsigned32 | M | | V |
CC-Request-Type 416 8.3 Enumerated | M | | V |
CC-Service-Specific- 417 8.26 Unsigned64 | M | | V |
Units | | | |
CC-Session-Failover 418 8.4 Enumerated | M | | V |
CC-Sub-Session-Id 419 8.5 Unsigned64 | M | | V |
CC-Time 420 8.21 Unsigned32 | M | | V |
CC-Total-Octets 421 8.23 Unsigned64 | M | | V |
CC-Unit-Type 454 8.32 Enumerated | M | | V |
Check-Balance-Result 422 8.6 Enumerated | M | | V |
Cost-Information 423 8.7 Grouped | M | | V |
Cost-Unit 424 8.12 UTF8String | M | | V |
Credit-Control 426 8.13 Enumerated | M | | V |
Credit-Control- 427 8.14 Enumerated | M | | V |
Failure-Handling | | | |
Currency-Code 425 8.11 Unsigned32 | M | | V |
Direct-Debiting- 428 8.15 Enumerated | M | | V |
Failure-Handling | | | |
Exponent 429 8.9 Integer32 | M | | V |
Final-Unit-Action 449 8.35 Enumerated | M | | V |
Final-Unit-Indication 430 8.34 Grouped | M | | V |
QoS-Final-Unit-Indication 669 8.68 Grouped | | M | V |
Granted-Service-Unit 431 8.17 Grouped | M | | V |
G-S-U-Pool-Identifier 453 8.31 Unsigned32 | M | | V |
G-S-U-Pool-Reference 457 8.30 Grouped | M | | V |
Multiple-Services- 456 8.16 Grouped | M | | V |
Credit-Control | | | |
Multiple-Services- 455 8.40 Enumerated | M | | V |
Indicator | | | |
Rating-Group 432 8.29 Unsigned32 | M | | V |
Redirect-Address-Type 433 8.38 Enumerated | M | | V |
Redirect-Server 434 8.37 Grouped | M | | V |
Redirect-Server-Address 435 8.39 UTF8String | M | | V |
Redirect-Server-Extension 665 8.64 Grouped | | M | V |
Redirect-Address- 666 8.65 Address | | M | V |
IPAddress | | | |
Redirect-Address-URL 667 8.66 UTF8String | | M | V |
Redirect-Address-SIP-URI 668 8.67 UTF8String | | M | V |
<span class="grey">Bertz, et al. Standards Track [Page 60]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-61" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Requested-Action 436 8.41 Enumerated | M | | V |
Requested-Service-Unit 437 8.18 Grouped | M | | V |
Restriction-Filter-Rule 438 8.36 IPFilterRule| M | | V |
Service-Context-Id 461 8.42 UTF8String | M | | V |
Service-Identifier 439 8.28 Unsigned32 | M | | V |
Service-Parameter-Info 440 8.43 Grouped | | M | V |
Service-Parameter-Type 441 8.44 Unsigned32 | | M | V |
Service-Parameter-Value 442 8.45 OctetString | | M | V |
Subscription-Id 443 8.46 Grouped | M | | V |
Subscription-Id-Data 444 8.48 UTF8String | M | | V |
Subscription-Id-Type 450 8.47 Enumerated | M | | V |
Subscription-Id-Extension 659 8.58 Grouped | | M | V |
Subscription-Id-E164 660 8.59 UTF8String | | M | V |
Subscription-Id-IMSI 661 8.60 UTF8String | | M | V |
Subscription-Id-SIP-URI 662 8.61 UTF8String | | M | V |
Subscription-Id-NAI 663 8.62 UTF8String | | M | V |
Subscription-Id-Private 664 8.63 UTF8String | | M | V |
Tariff-Change-Usage 452 8.27 Enumerated | M | | V |
Tariff-Time-Change 451 8.20 Time | M | | V |
Unit-Value 445 8.8 Grouped | M | | V |
Used-Service-Unit 446 8.19 Grouped | M | | V |
User-Equipment-Info 458 8.49 Grouped | | M | V |
User-Equipment-Info-Type 459 8.50 Enumerated | | M | V |
User-Equipment-Info-Value 460 8.51 OctetString | | M | V |
User-Equipment-Info- 653 8.52 Grouped | | M | V |
Extension | | | |
User-Equipment-Info- 654 8.53 OctetString | | M | V |
IMEISV | | | |
User-Equipment-Info-MAC 655 8.54 OctetString | | M | V |
User-Equipment-Info-EUI64 656 8.55 OctetString | | M | V |
User-Equipment-Info- 657 8.56 OctetString | | M | V |
ModifiedEUI64 | | | |
User-Equipment-Info-IMEI 658 8.57 OctetString | | M | V |
Value-Digits 447 8.10 Integer64 | M | | V |
Validity-Time 448 8.33 Unsigned32 | M | | V |
<span class="h3"><a class="selflink" id="section-8.1" href="#section-8.1">8.1</a>. CC-Correlation-Id AVP</span>
The CC-Correlation-Id AVP (AVP Code 411) is of type OctetString and
contains information to correlate credit-control requests generated
for different components of the service, e.g., transport and service
level. Whoever allocates the Service-Context-Id (i.e., a unique
identifier of a service-specific document) is also responsible for
defining the content and encoding of the CC-Correlation-Id AVP.
<span class="grey">Bertz, et al. Standards Track [Page 61]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-62" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-8.2" href="#section-8.2">8.2</a>. CC-Request-Number AVP</span>
The CC-Request-Number AVP (AVP Code 415) is of type Unsigned32 and
identifies this request within one session. As Session-Id AVPs are
globally unique, the combination of the Session-Id AVP and the
CC-Request-Number AVP is also globally unique and can be used in
matching credit-control messages with confirmations. An easy way to
produce unique numbers is to set the value of the CC-Request-Number
AVP to 0 for a credit-control request with a CC-Request-Type AVP of
INITIAL_REQUEST (the initial request in a session). The value of the
CC-Request-Number AVP should be set to 1 for the first
UPDATE_REQUEST, to 2 for the second, and so on until the value for
TERMINATION_REQUEST is one more than the value for the last
UPDATE_REQUEST. In the case of event charging (when the CC-Request-
Type AVP has the value EVENT_REQUEST), the CC-Request-Number AVP
should be set to 0 for a credit-control request.
<span class="h3"><a class="selflink" id="section-8.3" href="#section-8.3">8.3</a>. CC-Request-Type AVP</span>
The CC-Request-Type AVP (AVP Code 416) is of type Enumerated and
contains the reason for sending the Credit-Control-Request message.
It MUST be present in all Credit-Control-Request messages. The
following values are defined for the CC-Request-Type AVP (the value
of 0 (zero) is reserved):
INITIAL_REQUEST 1
This request is used to initiate a credit-control session. It
contains credit-control information that is relevant to the
initiation.
UPDATE_REQUEST 2
This request contains credit-control information for an existing
credit-control session. Credit-control requests of this type SHOULD
be sent every time a credit-control re-authorization is needed at the
expiry of the allocated quota or validity time. Further, additional
service-specific events MAY trigger a spontaneous UPDATE_REQUEST.
TERMINATION_REQUEST 3
This request is sent to terminate a credit-control session. It
contains credit-control information relevant to the existing session.
<span class="grey">Bertz, et al. Standards Track [Page 62]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-63" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
EVENT_REQUEST 4
This request is used when there is no need to maintain any
credit-control session state in the credit-control server. It
contains all information relevant to the service and is the only
request of the service. The reason for this request is further
detailed in the Requested-Action AVP. The Requested-Action AVP MUST
be included in the Credit-Control-Request message when CC-Request-
Type is set to EVENT_REQUEST.
<span class="h3"><a class="selflink" id="section-8.4" href="#section-8.4">8.4</a>. CC-Session-Failover AVP</span>
The CC-Session-Failover AVP (AVP Code 418) is of type Enumerated and
contains information as to whether moving the credit-control message
stream to a backup server during an ongoing credit-control session is
supported. In the case of communication failures, the credit-control
message streams can be moved to an alternative destination if the
credit-control server supports failover to an alternative server.
The secondary credit-control server name, if received from the home
Diameter AAA server, can be used as an address of the backup server.
An implementation is not required to support moving a credit-control
message stream to an alternative server, as this also requires moving
information related to the credit-control session to the backup
server.
The following values are defined for the CC-Session-Failover AVP:
FAILOVER_NOT_SUPPORTED 0
When the CC-Session-Failover AVP is set to FAILOVER_NOT_SUPPORTED,
the credit-control message stream MUST NOT be moved to an alternative
destination in the case of a communication failure. This is the
default behavior if the AVP isn't included in the reply from the
authorization or credit-control server.
FAILOVER_SUPPORTED 1
When the CC-Session-Failover AVP is set to FAILOVER_SUPPORTED, the
credit-control message stream SHOULD be moved to an alternative
destination in the case of a communication failure. Moving the
credit-control message stream to a backup server MAY require that
information related to the credit-control session should also be
forwarded to an alternative server.
<span class="grey">Bertz, et al. Standards Track [Page 63]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-64" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-8.5" href="#section-8.5">8.5</a>. CC-Sub-Session-Id AVP</span>
The CC-Sub-Session-Id AVP (AVP Code 419) is of type Unsigned64 and
contains the credit-control sub-session identifier. The combination
of the Session-Id AVP and this AVP MUST be unique per sub-session,
and the value of this AVP MUST be monotonically increased by one for
all new sub-sessions. The absence of this AVP implies that no
sub-sessions are in use.
<span class="h3"><a class="selflink" id="section-8.6" href="#section-8.6">8.6</a>. Check-Balance-Result AVP</span>
The Check-Balance-Result AVP (AVP Code 422) is of type Enumerated and
contains the result of the balance check. This AVP is applicable
only when the Requested-Action AVP indicates CHECK_BALANCE in the
Credit-Control-Request command. The following values are defined for
the Check-Balance-Result AVP:
ENOUGH_CREDIT 0
There is enough credit in the account to cover the requested service.
NO_CREDIT 1
There isn't enough credit in the account to cover the requested
service.
<span class="h3"><a class="selflink" id="section-8.7" href="#section-8.7">8.7</a>. Cost-Information AVP</span>
The Cost-Information AVP (AVP Code 423) is of type Grouped, and it is
used to return the cost information of a service, which the
credit-control client can transfer transparently to the end user.
The included Unit-Value AVP contains the cost estimate (always of
type "money") of the service in the case of price inquiries, or the
accumulated cost estimation in the case of a credit-control session.
The Currency-Code AVP specifies in which currency the cost was given.
The Cost-Unit AVP specifies the unit when the service cost is a cost
per unit (e.g., cost for the service is $1 per minute).
When the Requested-Action AVP with the value PRICE_ENQUIRY is
included in the Credit-Control-Request command, the Cost-Information
AVP sent in the succeeding Credit-Control-Answer command contains the
cost estimation for the requested service, without any reservations
being made.
<span class="grey">Bertz, et al. Standards Track [Page 64]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-65" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
The Cost-Information AVP included in the Credit-Control-Answer
command with the CC-Request-Type set to UPDATE_REQUEST contains the
accumulated cost estimation for the session, without taking any
credit reservations into account.
The Cost-Information AVP included in the Credit-Control-Answer
command with the CC-Request-Type set to EVENT_REQUEST or
TERMINATION_REQUEST contains the estimated total cost for the
requested service.
The Cost-Information AVP is defined as follows (per grouped-avp-def
as defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]):
Cost-Information ::= < AVP Header: 423 >
{ Unit-Value }
{ Currency-Code }
[ Cost-Unit ]
<span class="h3"><a class="selflink" id="section-8.8" href="#section-8.8">8.8</a>. Unit-Value AVP</span>
The Unit-Value AVP is of type Grouped (AVP Code 445) and specifies
the cost as a floating-point value. The Unit-Value is a significand
with an exponent; i.e., Unit-Value = Value-Digits AVP * 10^Exponent.
This representation avoids unwanted rounding off. For example, the
value of 2,3 is represented as Value-Digits = 23 and Exponent = -1.
The absence of the exponent part MUST be interpreted as an exponent
equal to zero.
The Unit-Value AVP is defined as follows (per grouped-avp-def as
defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]):
Unit-Value ::= < AVP Header: 445 >
{ Value-Digits }
[ Exponent ]
<span class="h3"><a class="selflink" id="section-8.9" href="#section-8.9">8.9</a>. Exponent AVP</span>
The Exponent AVP is of type Integer32 (AVP Code 429) and contains the
exponent value to be applied for the Value-Digits AVP within the
Unit-Value AVP.
<span class="grey">Bertz, et al. Standards Track [Page 65]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-66" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-8.10" href="#section-8.10">8.10</a>. Value-Digits AVP</span>
The Value-Digits AVP is of type Integer64 (AVP Code 447) and contains
the significant digits of the number. If decimal values are needed
to present the units, the scaling MUST be indicated with the related
Exponent AVP. For example, for the monetary amount $0.05, the value
of the Value-Digits AVP MUST be set to 5, and the scaling MUST be
indicated with the Exponent AVP set to -2.
<span class="h3"><a class="selflink" id="section-8.11" href="#section-8.11">8.11</a>. Currency-Code AVP</span>
The Currency-Code AVP (AVP Code 425) is of type Unsigned32 and
contains a currency code that specifies in which currency the values
of AVPs containing monetary units were given. It is specified by
using the numeric values defined in the ISO 4217 standard [<a href="#ref-ISO4217" title=""Codes for the representation of currencies"">ISO4217</a>].
<span class="h3"><a class="selflink" id="section-8.12" href="#section-8.12">8.12</a>. Cost-Unit AVP</span>
The Cost-Unit AVP (AVP Code 424) is of type UTF8String, and it is
used to display a human-readable string to the end user. It
specifies the applicable unit to the Cost-Information AVP when the
service cost is a cost per unit (e.g., cost of the service is $1 per
minute). The Cost-Unit setting can be minutes, hours, days,
kilobytes, megabytes, etc.
<span class="h3"><a class="selflink" id="section-8.13" href="#section-8.13">8.13</a>. Credit-Control AVP</span>
The Credit-Control AVP (AVP Code 426) is of type Enumerated and MUST
be included in AA-Request messages when the Service Element has
credit-control capabilities. The following values are defined for
the Credit-Control AVP:
CREDIT_AUTHORIZATION 0
If the home Diameter AAA server determines that the user has a
prepaid subscription, this value indicates that the credit-control
server MUST be contacted to perform the first interrogation. The
value of the Credit-Control AVP MUST always be set to 0 in an
AA-Request sent to perform the first interrogation and to initiate a
new credit-control session.
RE_AUTHORIZATION 1
This value indicates to the Diameter AAA server that a credit-control
session is ongoing for the subscriber and that the credit-control
server MUST NOT be contacted. The Credit-Control AVP set to the
value of 1 is to be used only when the first interrogation has been
successfully performed and the credit-control session is ongoing
<span class="grey">Bertz, et al. Standards Track [Page 66]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-67" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
(i.e., re-authorization triggered by authorization lifetime). This
value MUST NOT be used in an AA-Request sent to perform the first
interrogation.
<span class="h3"><a class="selflink" id="section-8.14" href="#section-8.14">8.14</a>. Credit-Control-Failure-Handling AVP (CCFH)</span>
The CCFH (AVP Code 427) is of type Enumerated. The credit-control
client uses information in this AVP to decide what to do if sending
credit-control messages to the credit-control server has been, for
instance, temporarily prevented due to a network problem. Depending
on the service logic, the credit-control server can order the client
to terminate the service immediately when there is a reason to
believe that the service cannot be charged, or to try failover to an
alternative server, if possible. The server could then either
terminate or grant the service, should the alternative connection
also fail.
The following values are defined for the CCFH:
TERMINATE 0
When the CCFH is set to TERMINATE, the service MUST only be granted
for as long as there is a connection to the credit-control server.
If the credit-control client does not receive any Credit-Control-
Answer messages before the Tx timer (as defined in <a href="#section-13">Section 13</a>)
expires, the credit-control request is regarded as failed, and the
end user's service session is terminated.
This is the default behavior if the AVP isn't included in the reply
from the authorization or credit-control server.
CONTINUE 1
When the CCFH is set to CONTINUE, the credit-control client SHOULD
resend the request to an alternative server in the case of transport
or temporary failures, provided that (1) a failover procedure is
supported in the credit-control server and the credit-control client
and (2) an alternative server is available. Otherwise, the service
SHOULD be granted, even if credit-control messages can't be
delivered.
RETRY_AND_TERMINATE 2
When the CCFH is set to RETRY_AND_TERMINATE, the credit-control
client SHOULD resend the request to an alternative server in the case
of transport or temporary failures, provided that (1) a failover
procedure is supported in the credit-control server and the
credit-control client and (2) an alternative server is available.
<span class="grey">Bertz, et al. Standards Track [Page 67]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-68" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Otherwise, the service SHOULD NOT be granted when the credit-control
messages can't be delivered.
<span class="h3"><a class="selflink" id="section-8.15" href="#section-8.15">8.15</a>. Direct-Debiting-Failure-Handling AVP (DDFH)</span>
The DDFH (AVP Code 428) is of type Enumerated. The credit-control
client uses information in this AVP to decide what to do if sending
credit-control messages (Requested-Action AVP set to DIRECT_DEBITING)
to the credit-control server has been, for instance, temporarily
prevented due to a network problem.
The following values are defined for the DDFH:
TERMINATE_OR_BUFFER 0
When the DDFH is set to TERMINATE_OR_BUFFER, the service MUST be
granted for as long as there is a connection to the credit-control
server. If the credit-control client does not receive any
Credit-Control-Answer messages before the Tx timer (as defined in
<a href="#section-13">Section 13</a>) expires, the credit-control request is regarded as
failed. The client SHOULD terminate the service if it can determine
from the failed answer that units have not been debited. Otherwise,
the credit-control client SHOULD grant the service, store the request
in application-level non-volatile storage, and try to resend the
request. These requests MUST be marked as possible duplicates by
setting the T flag in the command header as described in <a href="./rfc6733#section-3">[RFC6733],
Section 3</a>. This is the default behavior if the AVP isn't included in
the reply from the authorization server.
CONTINUE 1
When the DDFH is set to CONTINUE, the service SHOULD be granted, even
if credit-control messages can't be delivered, and the request should
be deleted.
<span class="h3"><a class="selflink" id="section-8.16" href="#section-8.16">8.16</a>. Multiple-Services-Credit-Control AVP</span>
The Multiple-Services-Credit-Control AVP (AVP Code 456) is of type
Grouped and contains the AVPs related to the independent
credit-control of multiple services. Note that each instance of this
AVP carries units related to one or more services or related to a
single rating-group.
The Service-Identifier AVP and the Rating-Group AVP are used to
associate the granted units to a given service or rating-group. If
both the Service-Identifier AVP and the Rating-Group AVP are
included, the target of the service units is always the service(s)
indicated by the value of the Service-Identifier AVP(s). If only the
<span class="grey">Bertz, et al. Standards Track [Page 68]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-69" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Rating-Group AVP is present, the Multiple-Services-Credit-Control AVP
relates to all the services that belong to the specified
rating-group.
The G-S-U-Pool-Reference AVP allows the server to specify a
G-S-U-Pool-Identifier identifying a credit pool within which the
units of the specified type are considered pooled. If a G-S-U-Pool-
Reference AVP is present, then actual service units of the specified
type MUST also be present. For example, if the G-S-U-Pool-Reference
AVP specifies a CC-Unit-Type value of TIME (<a href="#section-8.32">Section 8.32</a>), then the
CC-Time AVP MUST be present.
The Requested-Service-Unit AVP MAY contain the amount of requested
service units or the requested monetary value. It MUST be present in
the initial interrogation and within the intermediate interrogations
in which a new quota is requested. If the credit-control client does
not include the Requested-Service-Unit AVP in a request command --
because, for instance, it has determined that the end user terminated
the service -- the server MUST debit the used amount from the user's
account but MUST NOT return a new quota in the corresponding answer.
The Validity-Time, Result-Code, and Final-Unit-Indication or
QoS-Final-Unit-Indication AVPs MAY be present in a Credit-Control-
Answer command as defined in Sections <a href="#section-5.1.2">5.1.2</a> and <a href="#section-5.6">5.6</a> for graceful
service termination.
When both the Tariff-Time-Change AVP and the Tariff-Change-Usage AVP
are present, the server MUST include two separate instances of the
Multiple-Services-Credit-Control AVP with the Granted-Service-Unit
AVP associated to the same service-identifier and/or rating-group.
Where the two quotas are associated to the same pool or to different
pools, the credit-pooling mechanism defined in <a href="#section-5.1.2">Section 5.1.2</a> applies.
When the client is reporting used units before and after the tariff
time change, it MUST use the Tariff-Change-Usage AVP inside the
Used-Service-Unit AVP.
A server not implementing the independent credit-control of multiple
services MUST treat the Multiple-Services-Credit-Control AVP as an
invalid AVP.
<span class="grey">Bertz, et al. Standards Track [Page 69]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-70" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
The Multiple-Services-Credit-Control AVP is defined as follows (per
grouped-avp-def as defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]):
Multiple-Services-Credit-Control ::= < AVP Header: 456 >
[ Granted-Service-Unit ]
[ Requested-Service-Unit ]
*[ Used-Service-Unit ]
[ Tariff-Change-Usage ]
*[ Service-Identifier ]
[ Rating-Group ]
*[ G-S-U-Pool-Reference ]
[ Validity-Time ]
[ Result-Code ]
[ Final-Unit-Indication ]
[ QoS-Final-Unit-Indication ]
*[ AVP ]
<span class="h3"><a class="selflink" id="section-8.17" href="#section-8.17">8.17</a>. Granted-Service-Unit AVP</span>
The Granted-Service-Unit AVP (AVP Code 431) is of type Grouped and
contains the amount of units that the Diameter Credit-Control client
can provide to the end user until the service must be released or the
new Credit-Control-Request must be sent. A client is not required to
implement all the unit types, and it must treat unknown or
unsupported unit types in the Answer message as an incorrect CCA. In
this case, the client MUST terminate the credit-control session and
indicate the reason as DIAMETER_BAD_ANSWER in the Termination-Cause
AVP.
The Granted-Service-Unit AVP is defined as follows (per
grouped-avp-def as defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]):
Granted-Service-Unit ::= < AVP Header: 431 >
[ Tariff-Time-Change ]
[ CC-Time ]
[ CC-Money ]
[ CC-Total-Octets ]
[ CC-Input-Octets ]
[ CC-Output-Octets ]
[ CC-Service-Specific-Units ]
*[ AVP ]
<span class="grey">Bertz, et al. Standards Track [Page 70]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-71" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-8.18" href="#section-8.18">8.18</a>. Requested-Service-Unit AVP</span>
The Requested-Service-Unit AVP (AVP Code 437) is of type Grouped and
contains the amount of requested units specified by the Diameter
Credit-Control client. A server is not required to implement all the
unit types, and it must treat unknown or unsupported unit types as
invalid AVPs.
The Requested-Service-Unit AVP is defined as follows (per
grouped-avp-def as defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]):
Requested-Service-Unit ::= < AVP Header: 437 >
[ CC-Time ]
[ CC-Money ]
[ CC-Total-Octets ]
[ CC-Input-Octets ]
[ CC-Output-Octets ]
[ CC-Service-Specific-Units ]
*[ AVP ]
<span class="h3"><a class="selflink" id="section-8.19" href="#section-8.19">8.19</a>. Used-Service-Unit AVP</span>
The Used-Service-Unit AVP is of type Grouped (AVP Code 446) and
contains the amount of used units measured from the point when the
service became active or, if interim interrogations are used during
the session, from the point when the previous measurement ended.
Note: The value reported in a Used-Service-Unit AVP is not
necessarily related to the grant provided in a Granted-Service-Unit
AVP, e.g., the value in this AVP may exceed the value in the grant.
The Used-Service-Unit AVP is defined as follows (per grouped-avp-def
as defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]):
Used-Service-Unit ::= < AVP Header: 446 >
[ Tariff-Change-Usage ]
[ CC-Time ]
[ CC-Money ]
[ CC-Total-Octets ]
[ CC-Input-Octets ]
[ CC-Output-Octets ]
[ CC-Service-Specific-Units ]
*[ AVP ]
<span class="grey">Bertz, et al. Standards Track [Page 71]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-72" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-8.20" href="#section-8.20">8.20</a>. Tariff-Time-Change AVP</span>
The Tariff-Time-Change AVP (AVP Code 451) is of type Time. It is
sent from the server to the client and includes the time in seconds
since January 1, 1900, 00:00 UTC, when the tariff of the service will
be changed.
The tariff change mechanism is optional for the client and server,
and it is not used for time-based services (<a href="#section-5">Section 5</a>). If a client
does not support the tariff time change mechanism, it MUST treat the
Tariff-Time-Change AVP in the Answer message as an incorrect CCA. In
this case, the client terminates the credit-control session and
indicates the reason as DIAMETER_BAD_ANSWER in the Termination-Cause
AVP.
Omission of this AVP means that no tariff change is to be reported.
<span class="h3"><a class="selflink" id="section-8.21" href="#section-8.21">8.21</a>. CC-Time AVP</span>
The CC-Time AVP (AVP Code 420) is of type Unsigned32 and indicates
the length of the requested, granted, or used time in seconds.
<span class="h3"><a class="selflink" id="section-8.22" href="#section-8.22">8.22</a>. CC-Money AVP</span>
The CC-Money AVP (AVP Code 413) is of type Grouped and specifies the
monetary amount in the given currency. The Currency-Code AVP SHOULD
be included. The CC-Money AVP is defined as follows (per
grouped-avp-def as defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]):
CC-Money ::= < AVP Header: 413 >
{ Unit-Value }
[ Currency-Code ]
<span class="h3"><a class="selflink" id="section-8.23" href="#section-8.23">8.23</a>. CC-Total-Octets AVP</span>
The CC-Total-Octets AVP (AVP Code 421) is of type Unsigned64 and
contains the total number of requested, granted, or used octets
regardless of the direction (sent or received).
<span class="h3"><a class="selflink" id="section-8.24" href="#section-8.24">8.24</a>. CC-Input-Octets AVP</span>
The CC-Input-Octets AVP (AVP Code 412) is of type Unsigned64 and
contains the number of requested, granted, or used octets that
can be / have been received from the end user.
<span class="grey">Bertz, et al. Standards Track [Page 72]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-73" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-8.25" href="#section-8.25">8.25</a>. CC-Output-Octets AVP</span>
The CC-Output-Octets AVP (AVP Code 414) is of type Unsigned64 and
contains the number of requested, granted, or used octets that
can be / have been sent to the end user.
<span class="h3"><a class="selflink" id="section-8.26" href="#section-8.26">8.26</a>. CC-Service-Specific-Units AVP</span>
The CC-Service-Specific-Units AVP (AVP Code 417) is of type
Unsigned64 and specifies the number of service-specific units (e.g.,
number of events, points) given in a selected service. The service-
specific units always refer to the service identified in the Service-
Identifier AVP (or Rating-Group AVP when the Multiple-Services-
Credit-Control AVP is used).
<span class="h3"><a class="selflink" id="section-8.27" href="#section-8.27">8.27</a>. Tariff-Change-Usage AVP</span>
The Tariff-Change-Usage AVP (AVP Code 452) is of type Enumerated and
defines whether units are used before or after a tariff change, or
whether the units straddled a tariff change during the reporting
period. Omission of this AVP means that no tariff change has
occurred.
In addition, when present in Answer messages as part of the Multiple-
Services-Credit-Control AVP, this AVP defines whether units are
allocated to be used before or after a tariff change event.
When the Tariff-Time-Change AVP is present, omission of this AVP in
Answer messages means that the single-quota mechanism applies.
Tariff-Change-Usage can be set to one of the following values:
UNIT_BEFORE_TARIFF_CHANGE 0
When present in the Multiple-Services-Credit-Control AVP, this value
indicates the amount of units allocated for use before a tariff
change occurs.
When present in the Used-Service-Unit AVP, this value indicates the
amount of resource units used before a tariff change had occurred.
<span class="grey">Bertz, et al. Standards Track [Page 73]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-74" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
UNIT_AFTER_TARIFF_CHANGE 1
When present in the Multiple-Services-Credit-Control AVP, this value
indicates the amount of units allocated for use after a tariff change
occurs.
When present in the Used-Service-Unit AVP, this value indicates the
amount of resource units used after a tariff change had occurred.
UNIT_INDETERMINATE 2
This value is to be used only in the Used-Service-Unit AVP and
indicates the amount of resource units that straddle the tariff
change (e.g., the metering process reports to the credit-control
client in blocks of n octets, and one block straddled the tariff
change).
<span class="h3"><a class="selflink" id="section-8.28" href="#section-8.28">8.28</a>. Service-Identifier AVP</span>
The Service-Identifier AVP is of type Unsigned32 (AVP Code 439) and
contains the identifier of a service. The specific service the
request relates to is uniquely identified by the combination of the
Service-Context-Id AVP and the Service-Identifier AVP.
A usage example of this AVP is illustrated in <a href="#appendix-A.9">Appendix A.9</a>.
<span class="h3"><a class="selflink" id="section-8.29" href="#section-8.29">8.29</a>. Rating-Group AVP</span>
The Rating-Group AVP is of type Unsigned32 (AVP Code 432) and
contains the identifier of a rating-group. All the services subject
to the same rating type are part of the same rating-group. The
specific rating-group the request relates to is uniquely identified
by the combination of the Service-Context-Id AVP and the Rating-Group
AVP.
A usage example of this AVP is illustrated in <a href="#appendix-A.9">Appendix A.9</a>.
<span class="h3"><a class="selflink" id="section-8.30" href="#section-8.30">8.30</a>. G-S-U-Pool-Reference AVP</span>
The G-S-U-Pool-Reference AVP (AVP Code 457) is of type Grouped. It
is used in the Credit-Control-Answer message and associates the
Granted-Service-Unit AVP within which it appears with a credit pool
within the session.
The G-S-U-Pool-Identifier AVP specifies the credit pool from which
credit is drawn for this unit type.
<span class="grey">Bertz, et al. Standards Track [Page 74]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-75" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
The CC-Unit-Type AVP specifies the type of units for which credit is
pooled.
The Unit-Value AVP specifies the multiplier, which converts between
service units of type CC-Unit-Type and abstract service units within
the credit pool (and thus to service units of any other services or
rating-groups associated with the same pool).
The G-S-U-Pool-Reference AVP is defined as follows (per
grouped-avp-def as defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]):
G-S-U-Pool-Reference ::= < AVP Header: 457 >
{ G-S-U-Pool-Identifier }
{ CC-Unit-Type }
{ Unit-Value }
<span class="h3"><a class="selflink" id="section-8.31" href="#section-8.31">8.31</a>. G-S-U-Pool-Identifier AVP</span>
The G-S-U-Pool-Identifier AVP (AVP Code 453) is of type Unsigned32
and identifies a credit pool within the session.
<span class="h3"><a class="selflink" id="section-8.32" href="#section-8.32">8.32</a>. CC-Unit-Type AVP</span>
The CC-Unit-Type AVP (AVP Code 454) is of type Enumerated and
specifies the type of units considered to be pooled into a
credit pool.
The following values are defined for the CC-Unit-Type AVP:
TIME 0
MONEY 1
TOTAL-OCTETS 2
INPUT-OCTETS 3
OUTPUT-OCTETS 4
SERVICE-SPECIFIC-UNITS 5
<span class="h3"><a class="selflink" id="section-8.33" href="#section-8.33">8.33</a>. Validity-Time AVP</span>
The Validity-Time AVP is of type Unsigned32 (AVP Code 448). It is
sent from the credit-control server to the credit-control client.
The Validity-Time AVP contains the validity time of the granted
service units. The measurement of the Validity-Time is started upon
receipt of the Credit-Control-Answer message containing this AVP. If
the granted service units have not been consumed within the validity
time specified in this AVP, the credit-control client MUST send a
Credit-Control-Request message to the server, with CC-Request-Type
set to UPDATE_REQUEST. The value field of the Validity-Time AVP is
given in seconds.
<span class="grey">Bertz, et al. Standards Track [Page 75]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-76" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
The Validity-Time AVP is also used for graceful service termination
(see <a href="#section-5.6">Section 5.6</a>) to indicate to the credit-control client how long
the subscriber is allowed to use network resources after the
specified action (i.e., REDIRECT or RESTRICT_ACCESS) started. When
the Validity-Time elapses, a new intermediate interrogation is sent
to the server.
<span class="h3"><a class="selflink" id="section-8.34" href="#section-8.34">8.34</a>. Final-Unit-Indication AVP</span>
The Final-Unit-Indication AVP (AVP Code 430) is of type Grouped and
indicates that the Granted-Service-Unit AVP in the Credit-Control-
Answer or in the AA-Answer contains the final units for the service.
After these units have expired, the Diameter Credit-Control client is
responsible for executing the action indicated in the Final-Unit-
Action AVP (see <a href="#section-5.6">Section 5.6</a>).
If more than one unit type is received in the Credit-Control-Answer,
the unit type that first expired SHOULD cause the credit-control
client to execute the specified action.
In the first interrogation, the Final-Unit-Indication AVP with
Final-Unit-Action set to REDIRECT or RESTRICT_ACCESS can also be
present with no Granted-Service-Unit AVP in the Credit-Control-Answer
or in the AA-Answer. This indicates to the Diameter Credit-Control
client that the client is to execute the specified action
immediately. If the home service provider policy is to terminate the
service, naturally, the server SHOULD return the appropriate
transient failure (see <a href="#section-9.1">Section 9.1</a>) in order to implement the policy-
defined action.
The Final-Unit-Action AVP defines the behavior of the Service Element
when the user's account cannot cover the cost of the service and MUST
always be present if the Final-Unit-Indication AVP is included in a
command.
If the Final-Unit-Action AVP is set to TERMINATE, the Final-Unit-
Indication group AVP MUST NOT contain any other AVPs.
If the Final-Unit-Action AVP is set to REDIRECT, the Redirect-Server
AVP or the Redirect-Server-Extension AVP (at least one) MUST be
present. The Restriction-Filter-Rule AVP or the Filter-Id AVP MAY be
present in the Credit-Control-Answer message if the user is also
allowed to access other services that are not accessible through the
address given in the Redirect-Server AVP.
If the Final-Unit-Action AVP is set to RESTRICT_ACCESS, either the
Restriction-Filter-Rule AVP or the Filter-Id AVP SHOULD be present.
<span class="grey">Bertz, et al. Standards Track [Page 76]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-77" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
The Filter-Id AVP is defined in [<a href="./rfc7155" title=""Diameter Network Access Server Application"">RFC7155</a>]. The Filter-Id AVP can be
used to reference an IP filter list installed in the access device by
means other than the Diameter Credit-Control application, e.g.,
locally configured or configured by another entity.
If the Final-Unit-Action AVP is set to REDIRECT and the type of
server is not one of the enumerations in the Redirect-Address-Type
AVP, then the QoS-Final-Unit-Indication AVP SHOULD be used together
with the Redirect-Server-Extension AVP instead of the Final-Unit-
Indication AVP.
If the Final-Unit-Action AVP is set to RESTRICT_ACCESS or REDIRECT
and the classification of the restricted traffic cannot be expressed
using an IPFilterRule, or if actions (e.g., QoS) other than just
allowing traffic need to be enforced, then the QoS-Final-Unit-
Indication AVP SHOULD be used instead of the Final-Unit-Indication
AVP. However, if the credit-control server wants to preserve
backward compatibility with credit-control clients that support only
[<a href="./rfc4006" title=""Diameter Credit-Control Application"">RFC4006</a>], the Final-Unit-Indication AVP SHOULD be used together with
the Filter-Id AVP.
The Final-Unit-Indication AVP is defined as follows (per
grouped-avp-def as defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]):
Final-Unit-Indication ::= < AVP Header: 430 >
{ Final-Unit-Action }
*[ Restriction-Filter-Rule ]
*[ Filter-Id ]
[ Redirect-Server ]
<span class="h3"><a class="selflink" id="section-8.35" href="#section-8.35">8.35</a>. Final-Unit-Action AVP</span>
The Final-Unit-Action AVP (AVP Code 449) is of type Enumerated and
indicates to the credit-control client the action to be taken when
the user's account cannot cover the service cost.
Final-Unit-Action can be set to one of the following values:
TERMINATE 0
The credit-control client MUST terminate the service session. This
is the default handling, applicable whenever the credit-control
client receives an unsupported Final-Unit-Action value, and it MUST
be supported by all the Diameter Credit-Control client
implementations conforming to this specification.
<span class="grey">Bertz, et al. Standards Track [Page 77]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-78" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
REDIRECT 1
The Service Element MUST redirect the user to the address specified
in the Redirect-Server-Address AVP or one of the AVPs included in the
Redirect-Server-Extension AVP. The redirect action is defined in
<a href="#section-5.6.2">Section 5.6.2</a>.
RESTRICT_ACCESS 2
The access device MUST restrict the user's access according to the
filter AVPs contained in the applied Grouped AVP: according to IP
packet filters defined in the Restriction-Filter-Rule AVP, according
to the packet classifier filters defined in the Filter-Rule AVP, or
according to the packet filters identified by the Filter-Id AVP. All
of the packets not matching any restriction filters (see
<a href="#section-5.6.3">Section 5.6.3</a>) MUST be dropped.
<span class="h3"><a class="selflink" id="section-8.36" href="#section-8.36">8.36</a>. Restriction-Filter-Rule AVP</span>
The Restriction-Filter-Rule AVP (AVP Code 438) is of type
IPFilterRule and provides filter rules corresponding to services that
are to remain accessible even if there are no more service units
granted. The access device has to configure the specified filter
rules for the subscriber and MUST drop all the packets not matching
these filters. Zero, one, or more such AVPs MAY be present in a
Credit-Control-Answer message or in an AA-Answer message.
<span class="h3"><a class="selflink" id="section-8.37" href="#section-8.37">8.37</a>. Redirect-Server AVP</span>
The Redirect-Server AVP (AVP Code 434) is of type Grouped and
contains the address information of the redirect server (e.g., HTTP
redirect server, SIP Server) with which the end user is to be
connected when the account cannot cover the service cost. It MUST be
present when the Final-Unit-Action AVP is set to REDIRECT.
The Redirect-Server AVP is defined as follows (per grouped-avp-def as
defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]):
Redirect-Server ::= < AVP Header: 434 >
{ Redirect-Address-Type }
{ Redirect-Server-Address }
<span class="grey">Bertz, et al. Standards Track [Page 78]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-79" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-8.38" href="#section-8.38">8.38</a>. Redirect-Address-Type AVP</span>
The Redirect-Address-Type AVP (AVP Code 433) is of type Enumerated
and defines the address type of the address given in the Redirect-
Server-Address AVP.
Redirect-Address-Type can be set to one of the following values:
IPv4 Address 0
The address type is in the form of a "dotted-decimal" IPv4 address,
as defined in [<a href="./rfc791" title=""Internet Protocol"">RFC791</a>].
IPv6 Address 1
The address type is in the form of an IPv6 address, as defined in
[<a href="./rfc4291" title=""IP Version 6 Addressing Architecture"">RFC4291</a>]. The address MUST conform to the textual representation of
the address according to [<a href="./rfc5952" title=""A Recommendation for IPv6 Address Text Representation"">RFC5952</a>].
Because [<a href="./rfc5952" title=""A Recommendation for IPv6 Address Text Representation"">RFC5952</a>] is more restrictive than the "<a href="./rfc3513">RFC 3513</a>" format
required by [<a href="./rfc4006" title=""Diameter Credit-Control Application"">RFC4006</a>], some legacy implementations may not be
compliant with the new requirements. Accordingly, implementations
receiving this AVP MAY be liberal in the textual IPv6 representations
that are accepted, without raising an error.
URL 2
The address type is in the form of a Uniform Resource Locator, as
defined in [<a href="./rfc3986" title=""Uniform Resource Identifier (URI): Generic Syntax"">RFC3986</a>].
SIP URI 3
The address type is in the form of a SIP Uniform Resource Identifier,
as defined in [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>].
<span class="h3"><a class="selflink" id="section-8.39" href="#section-8.39">8.39</a>. Redirect-Server-Address AVP</span>
The Redirect-Server-Address AVP (AVP Code 435) is of type UTF8String
and defines the address of the redirect server (e.g., HTTP redirect
server, SIP Server) with which the end user is to be connected when
the account cannot cover the service cost.
<span class="grey">Bertz, et al. Standards Track [Page 79]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-80" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-8.40" href="#section-8.40">8.40</a>. Multiple-Services-Indicator AVP</span>
The Multiple-Services-Indicator AVP (AVP Code 455) is of type
Enumerated and indicates whether the Diameter Credit-Control client
is capable of handling multiple services independently within a
(sub-)session. The absence of this AVP means that independent
credit-control of multiple services is not supported.
A server not implementing the independent credit-control of multiple
services MUST treat the Multiple-Services-Indicator AVP as an
invalid AVP.
The following values are defined for the Multiple-Services-Indicator
AVP:
MULTIPLE_SERVICES_NOT_SUPPORTED 0
The client does not support independent credit-control of multiple
services within a (sub-)session.
MULTIPLE_SERVICES_SUPPORTED 1
The client supports independent credit-control of multiple services
within a (sub-)session.
<span class="h3"><a class="selflink" id="section-8.41" href="#section-8.41">8.41</a>. Requested-Action AVP</span>
The Requested-Action AVP (AVP Code 436) is of type Enumerated and
contains the requested action being sent in a Credit-Control-Request
command where the CC-Request-Type is set to EVENT_REQUEST. The
following values are defined for the Requested-Action AVP:
DIRECT_DEBITING 0
This indicates a request to decrease the end user's account according
to information specified in the Requested-Service-Unit AVP and/or
Service-Identifier AVP (additional rating information may be included
in service-specific AVPs or in the Service-Parameter-Info AVP). The
Granted-Service-Unit AVP in the Credit-Control-Answer command
contains the debited units.
<span class="grey">Bertz, et al. Standards Track [Page 80]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-81" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
REFUND_ACCOUNT 1
This indicates a request to increase the end user's account according
to information specified in the Requested-Service-Unit AVP and/or
Service-Identifier AVP (additional rating information may be included
in service-specific AVPs or in the Service-Parameter-Info AVP). The
Granted-Service-Unit AVP in the Credit-Control-Answer command
contains the refunded units.
CHECK_BALANCE 2
This indicates a balance-check request. In this case, the checking
of the account balance is done without any credit reservations from
the account. The Check-Balance-Result AVP in the Credit-Control-
Answer command contains the result of the balance check.
PRICE_ENQUIRY 3
This indicates a price-inquiry request. In this case, neither
checking of the account balance nor reservation from the account will
be done; only the price of the service will be returned in the
Cost-Information AVP in the Credit-Control-Answer command.
<span class="h3"><a class="selflink" id="section-8.42" href="#section-8.42">8.42</a>. Service-Context-Id AVP</span>
The Service-Context-Id AVP is of type UTF8String (AVP Code 461) and
contains a unique identifier of the Diameter Credit-Control service-
specific document (as defined in <a href="#section-4.1.2">Section 4.1.2</a>) that applies to the
request. This is an identifier allocated by the service provider,
the Service Element manufacturer, or a standardization body, and MUST
uniquely identify a given Diameter Credit-Control service-specific
document. The format of the Service-Context-Id is:
"service-context" "@" "domain"
service-context = Token
The Token is an arbitrary string of characters and digits.
"domain" represents the entity that allocated the Service-Context-Id.
It can be ietf.org, 3gpp.org, etc. if the identifier is allocated by
a standardization body, or it can be the Fully Qualified Domain Name
(FQDN) of the service provider (e.g., provider.example.com) or the
vendor (e.g., vendor.example.com) if the identifier is allocated by a
private entity.
This AVP SHOULD be placed as close to the Diameter header as
possible.
<span class="grey">Bertz, et al. Standards Track [Page 81]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-82" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Service-specific documents that are for private use only (i.e., for
one provider's own use, where no interoperability is deemed useful)
may define private identifiers without a need for coordination.
However, when interoperability is desired, coordination of the
identifiers via, for example, publication of an informational RFC is
RECOMMENDED in order to make the Service-Context-Id AVP globally
available.
<span class="h3"><a class="selflink" id="section-8.43" href="#section-8.43">8.43</a>. Service-Parameter-Info AVP</span>
The Service-Parameter-Info AVP (AVP Code 440) is of type Grouped and
contains service-specific information used for price calculation or
rating. The Service-Parameter-Type AVP defines the service parameter
type, and the Service-Parameter-Value AVP contains the parameter
value. The actual contents of these AVPs are not within the scope of
this document and SHOULD be defined in another Diameter application,
in standards written by other standardization bodies, or in service-
specific documentation.
In the case of an unknown service request (e.g., unknown Service-
Parameter-Type), the corresponding Answer message MUST contain the
error code DIAMETER_RATING_FAILED. A Credit-Control-Answer message
with this error MUST contain one or more Failed-AVP AVPs containing
the Service-Parameter-Info AVPs that caused the failure.
The Service-Parameter-Info AVP is defined as follows (per
grouped-avp-def as defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]):
Service-Parameter-Info ::= < AVP Header: 440 >
{ Service-Parameter-Type }
{ Service-Parameter-Value }
<span class="h3"><a class="selflink" id="section-8.44" href="#section-8.44">8.44</a>. Service-Parameter-Type AVP</span>
The Service-Parameter-Type AVP is of type Unsigned32 (AVP Code 441)
and defines the type of the service-event-specific parameter (e.g.,
it can be the end-user location or service name). The different
parameters and their types are service specific, and the meanings of
these parameters are not defined in this document. Whoever allocates
the Service-Context-Id (i.e., a unique identifier of a service-
specific document) is also responsible for assigning Service-
Parameter-Type values for the service and ensuring their uniqueness
within the given service. The Service-Parameter-Value AVP contains
the value associated with the service parameter type.
<span class="grey">Bertz, et al. Standards Track [Page 82]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-83" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-8.45" href="#section-8.45">8.45</a>. Service-Parameter-Value AVP</span>
The Service-Parameter-Value AVP is of type OctetString (AVP Code 442)
and contains the value of the service parameter type.
<span class="h3"><a class="selflink" id="section-8.46" href="#section-8.46">8.46</a>. Subscription-Id AVP</span>
The Subscription-Id AVP (AVP Code 443) is used to identify the
end user's subscription and is of type Grouped. The Subscription-Id
AVP includes a Subscription-Id-Data AVP that holds the identifier and
a Subscription-Id-Type AVP that defines the identifier type.
The Subscription-Id AVP is defined as follows (per grouped-avp-def as
defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]):
Subscription-Id ::= < AVP Header: 443 >
{ Subscription-Id-Type }
{ Subscription-Id-Data }
<span class="h3"><a class="selflink" id="section-8.47" href="#section-8.47">8.47</a>. Subscription-Id-Type AVP</span>
The Subscription-Id-Type AVP (AVP Code 450) is of type Enumerated,
and it is used to determine which type of identifier is carried by
the Subscription-Id AVP.
This specification defines the following subscription identifiers.
However, new Subscription-Id-Type values can be assigned by IANA as
defined in <a href="#section-12">Section 12</a>. A server MUST implement all the Subscription-
Id-Type values required to perform credit authorization for the
services it supports, including possible future values. Unknown or
unsupported Subscription-Id-Type values MUST be treated according to
the 'M' flag rule, as defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>].
END_USER_E164 0
The identifier is in international E.164 format (e.g., MSISDN),
according to the ITU-T E.164 numbering plan defined in [<a href="#ref-E164" title=""The international public telecommunication numbering plan"">E164</a>] and
[<a href="#ref-CE164" title=""COMPLEMENT TO ITU-T RECOMMENDATION E.164 (11/2010): LIST OF ITU-T RECOMMENDATION E.164 ASSIGNED COUNTRY CODES"">CE164</a>].
END_USER_IMSI 1
The identifier is in IMSI format, according to the ITU-T E.212
identification plan as defined in [<a href="#ref-E212" title=""The international identification plan for public networks and subscriptions"">E212</a>] and [<a href="#ref-CE212" title=""COMPLEMENT TO RECOMMENDATION ITU-T E.212 (09/2016): LIST OF MOBILE COUNTRY OR GEOGRAPHICAL AREA CODES"">CE212</a>].
END_USER_SIP_URI 2
The identifier is in the form of a SIP URI, as defined in [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>].
<span class="grey">Bertz, et al. Standards Track [Page 83]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-84" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
END_USER_NAI 3
The identifier is in the form of a Network Access Identifier, as
defined in [<a href="./rfc7542" title=""The Network Access Identifier"">RFC7542</a>].
END_USER_PRIVATE 4
The identifier is a credit-control server private identifier.
<span class="h3"><a class="selflink" id="section-8.48" href="#section-8.48">8.48</a>. Subscription-Id-Data AVP</span>
The Subscription-Id-Data AVP (AVP Code 444) is used to identify the
end user and is of type UTF8String. The Subscription-Id-Type AVP
defines which type of identifier is used.
<span class="h3"><a class="selflink" id="section-8.49" href="#section-8.49">8.49</a>. User-Equipment-Info AVP</span>
The User-Equipment-Info AVP (AVP Code 458) is of type Grouped and
allows the credit-control client to indicate the identity and
capability of the terminal the subscriber is using for the connection
to the network.
The User-Equipment-Info AVP is defined as follows (per
grouped-avp-def as defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]):
User-Equipment-Info ::= < AVP Header: 458 >
{ User-Equipment-Info-Type }
{ User-Equipment-Info-Value }
<span class="h3"><a class="selflink" id="section-8.50" href="#section-8.50">8.50</a>. User-Equipment-Info-Type AVP</span>
The User-Equipment-Info-Type AVP is of type Enumerated (AVP Code 459)
and defines the type of user equipment information contained in the
User-Equipment-Info-Value AVP.
This specification defines the following user equipment types.
However, new User-Equipment-Info-Type values can be assigned by IANA
as defined in <a href="#section-12">Section 12</a>.
IMEISV 0
The identifier contains the International Mobile Equipment Identifier
and Software Version (IMEISV) in the IMEISV format according to 3GPP
TS 23.003 [<a href="#ref-TGPPIMEI" title=""Numbering, addressing and identification (release 15)"">TGPPIMEI</a>].
<span class="grey">Bertz, et al. Standards Track [Page 84]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-85" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
MAC 1
The 48-bit Media Access Control (MAC) address is formatted as
described in <a href="./rfc3580#section-3.21">Section 3.21 of [RFC3580]</a>.
EUI64 2
The 64-bit identifier used to identify the hardware instance of the
product, as defined in [<a href="#ref-EUI64" title=""Guidelines for Use of Extended Unique Identifier (EUI), Organizationally Unique Identifier (OUI), and Company ID (CID)"">EUI64</a>].
MODIFIED_EUI64 3
There are a number of types of terminals that have identifiers other
than the International Mobile Equipment Identifier (IMEI), IEEE 802
MACs, or EUI-64. These identifiers can be converted to modified
EUI-64 format as described in [<a href="./rfc4291" title=""IP Version 6 Addressing Architecture"">RFC4291</a>] or by using some other
methods referred to in the service-specific documentation.
<span class="h3"><a class="selflink" id="section-8.51" href="#section-8.51">8.51</a>. User-Equipment-Info-Value AVP</span>
The User-Equipment-Info-Value AVP (AVP Code 460) is of type
OctetString. The User-Equipment-Info-Type AVP defines which type of
identifier is used.
<span class="h3"><a class="selflink" id="section-8.52" href="#section-8.52">8.52</a>. User-Equipment-Info-Extension AVP</span>
The User-Equipment-Info-Extension AVP (AVP Code 653) is of type
Grouped and allows the credit-control client to indicate the identity
and capability of the terminal the subscriber is using for the
connection to the network. If the type of the equipment is one of
the enumerated User-Equipment-Info-Type AVP values, then the
credit-control client SHOULD send the information in the
User-Equipment-Info AVP, in addition to or instead of the
User-Equipment-Info-Extension AVP. This is done in order to preserve
backward compatibility with credit-control servers that support only
[<a href="./rfc4006" title=""Diameter Credit-Control Application"">RFC4006</a>]. Exactly one AVP MUST be included inside the
User-Equipment-Info-Extension AVP.
<span class="grey">Bertz, et al. Standards Track [Page 85]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-86" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
The User-Equipment-Info-Extension AVP is defined as follows (per
grouped-avp-def as defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]):
User-Equipment-Info-Extension ::= < AVP Header: 653 >
[ User-Equipment-Info-IMEISV ]
[ User-Equipment-Info-MAC ]
[ User-Equipment-Info-EUI64 ]
[ User-Equipment-Info-ModifiedEUI64 ]
[ User-Equipment-Info-IMEI ]
[ AVP ]
<span class="h3"><a class="selflink" id="section-8.53" href="#section-8.53">8.53</a>. User-Equipment-Info-IMEISV AVP</span>
The User-Equipment-Info-IMEISV AVP (AVP Code 654) is of type
OctetString. The User-Equipment-Info-IMEISV AVP contains the
International Mobile Equipment Identifier and Software Version in the
IMEISV format according to 3GPP TS 23.003 [<a href="#ref-TGPPIMEI" title=""Numbering, addressing and identification (release 15)"">TGPPIMEI</a>].
<span class="h3"><a class="selflink" id="section-8.54" href="#section-8.54">8.54</a>. User-Equipment-Info-MAC AVP</span>
The User-Equipment-Info-MAC AVP (AVP Code 655) is of type
OctetString. The User-Equipment-Info-MAC AVP contains the 48-bit MAC
address; the MAC address is formatted as described in <a href="./rfc5777#section-4.1.7.8">Section 4.1.7.8
of [RFC5777]</a>.
<span class="h3"><a class="selflink" id="section-8.55" href="#section-8.55">8.55</a>. User-Equipment-Info-EUI64 AVP</span>
The User-Equipment-Info-EUI64 AVP (AVP Code 656) is of type
OctetString. The User-Equipment-Info-EUI64 AVP contains the 64-bit
identifier used to identify the hardware instance of the product, as
defined in [<a href="#ref-EUI64" title=""Guidelines for Use of Extended Unique Identifier (EUI), Organizationally Unique Identifier (OUI), and Company ID (CID)"">EUI64</a>].
<span class="h3"><a class="selflink" id="section-8.56" href="#section-8.56">8.56</a>. User-Equipment-Info-ModifiedEUI64 AVP</span>
The User-Equipment-Info-ModifiedEUI64 AVP (AVP Code 657) is of type
OctetString. There are a number of types of terminals that have
identifiers other than IMEI, IEEE 802 MACs, or EUI-64. These
identifiers can be converted to modified EUI-64 format as described
in [<a href="./rfc4291" title=""IP Version 6 Addressing Architecture"">RFC4291</a>] or by using some other methods referred to in the
service-specific documentation. The User-Equipment-Info-
ModifiedEUI64 AVP contains such identifiers.
<span class="h3"><a class="selflink" id="section-8.57" href="#section-8.57">8.57</a>. User-Equipment-Info-IMEI AVP</span>
The User-Equipment-Info-IMEI AVP (AVP Code 658) is of type
OctetString. The User-Equipment-Info-IMEI AVP contains the
International Mobile Equipment Identifier in the IMEI format
according to 3GPP TS 23.003 [<a href="#ref-TGPPIMEI" title=""Numbering, addressing and identification (release 15)"">TGPPIMEI</a>].
<span class="grey">Bertz, et al. Standards Track [Page 86]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-87" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-8.58" href="#section-8.58">8.58</a>. Subscription-Id-Extension AVP</span>
The Subscription-Id-Extension AVP (AVP Code 659) is used to identify
the end user's subscription and is of type Grouped. The
Subscription-Id-Extension group AVP MUST include an AVP holding the
subscription identifier. The type of this included AVP indicates the
type of the subscription identifier. For each of the enumerated
values of the Subscription-Id-Type AVP, there is a corresponding
sub-AVP for use within the Subscription-Id-Extension group AVP. If a
new identifier type is required, a corresponding new sub-AVP SHOULD
be defined for use within the Subscription-Id-Extension group AVP.
If full backward compatibility with [<a href="./rfc4006" title=""Diameter Credit-Control Application"">RFC4006</a>] is required, then the
Subscription-Id AVP MUST be used to indicate identifier types
enumerated in the Subscription-Id-Type AVP, whereas the Subscription-
Id-Extension AVP MUST be used only for newly defined identifier
types. If full backward compatibility with [<a href="./rfc4006" title=""Diameter Credit-Control Application"">RFC4006</a>] is not
required, then the Subscription-Id-Extension AVP MAY be used to carry
the existing identifier types. In this case, the Subscription-Id-
Extension AVP MAY be sent together with the Subscription-Id AVP.
Exactly one sub-AVP MUST be included inside the Subscription-Id-
Extension AVP.
The Subscription-Id-Extension AVP is defined as follows (per
grouped-avp-def as defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]):
Subscription-Id-Extension ::= < AVP Header: 659 >
[ Subscription-Id-E164 ]
[ Subscription-Id-IMSI ]
[ Subscription-Id-SIP-URI ]
[ Subscription-Id-NAI ]
[ Subscription-Id-Private ]
[ AVP ]
<span class="h3"><a class="selflink" id="section-8.59" href="#section-8.59">8.59</a>. Subscription-Id-E164 AVP</span>
The Subscription-Id-E164 AVP (AVP Code 660) is of type UTF8String.
The Subscription-Id-E164 AVP contains the international E.164 format
(e.g., MSISDN), according to the ITU-T E.164 numbering plan defined
in [<a href="#ref-E164" title=""The international public telecommunication numbering plan"">E164</a>] and [<a href="#ref-CE164" title=""COMPLEMENT TO ITU-T RECOMMENDATION E.164 (11/2010): LIST OF ITU-T RECOMMENDATION E.164 ASSIGNED COUNTRY CODES"">CE164</a>].
<span class="h3"><a class="selflink" id="section-8.60" href="#section-8.60">8.60</a>. Subscription-Id-IMSI AVP</span>
The Subscription-Id-IMSI AVP (AVP Code 661) is of type UTF8String.
The Subscription-Id-IMSI AVP contains the IMSI format, according to
the ITU-T E.212 identification plan as defined in [<a href="#ref-E212" title=""The international identification plan for public networks and subscriptions"">E212</a>] and [<a href="#ref-CE212" title=""COMPLEMENT TO RECOMMENDATION ITU-T E.212 (09/2016): LIST OF MOBILE COUNTRY OR GEOGRAPHICAL AREA CODES"">CE212</a>].
<span class="grey">Bertz, et al. Standards Track [Page 87]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-88" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-8.61" href="#section-8.61">8.61</a>. Subscription-Id-SIP-URI AVP</span>
The Subscription-Id-SIP-URI AVP (AVP Code 662) is of type UTF8String.
The Subscription-Id-SIP-URI AVP contains the identifier in the form
of a SIP URI, as defined in [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>].
<span class="h3"><a class="selflink" id="section-8.62" href="#section-8.62">8.62</a>. Subscription-Id-NAI AVP</span>
The Subscription-Id-NAI AVP (AVP Code 663) is of type UTF8String.
The Subscription-Id-NAI AVP contains the identifier in the form of a
Network Access Identifier, as defined in [<a href="./rfc7542" title=""The Network Access Identifier"">RFC7542</a>].
<span class="h3"><a class="selflink" id="section-8.63" href="#section-8.63">8.63</a>. Subscription-Id-Private AVP</span>
The Subscription-Id-Private AVP (AVP Code 664) is of type UTF8String.
The Subscription-Id-Private AVP contains a credit-control server
private identifier.
<span class="h3"><a class="selflink" id="section-8.64" href="#section-8.64">8.64</a>. Redirect-Server-Extension AVP</span>
The Redirect-Server-Extension AVP (AVP Code 665) is of type Grouped
and contains the address information of the redirect server (e.g.,
HTTP redirect server, SIP Server) with which the end user is to be
connected when the account cannot cover the service cost. It MUST be
present inside the QoS-Final-Unit-Indication AVP when the Final-Unit-
Action AVP is set to REDIRECT. If the type of the redirect server is
one of the enumerated values of the Redirect-Address-Type AVP, then
the credit-control server SHOULD send the information in the
Redirect-Server AVP, in addition to or instead of the Redirect-
Server-Extension AVP. This is done in order to preserve backward
compatibility with credit-control clients that support only
[<a href="./rfc4006" title=""Diameter Credit-Control Application"">RFC4006</a>]. Exactly one AVP MUST be included inside the Redirect-
Server-Extension AVP.
The Redirect-Server-Extension AVP is defined as follows (per
grouped-avp-def as defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]):
Redirect-Server-Extension ::= < AVP Header: 665 >
[ Redirect-Address-IPAddress ]
[ Redirect-Address-URL ]
[ Redirect-Address-SIP-URI ]
[ AVP ]
<span class="grey">Bertz, et al. Standards Track [Page 88]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-89" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-8.65" href="#section-8.65">8.65</a>. Redirect-Address-IPAddress AVP</span>
The Redirect-Address-IPAddress AVP (AVP Code 666) is of type Address
and defines the IPv4 or IPv6 address of the redirect server with
which the end user is to be connected when the account cannot cover
the service cost.
When encoded as an IPv6 address in 16 bytes, the IPv4-mapped IPv6
format [<a href="./rfc4291" title=""IP Version 6 Addressing Architecture"">RFC4291</a>] MAY be used to indicate an IPv4 address.
The interpretation of Redirect-Address-IPAddress by the Diameter
Credit-Control client is a matter of local policy.
<span class="h3"><a class="selflink" id="section-8.66" href="#section-8.66">8.66</a>. Redirect-Address-URL AVP</span>
The Redirect-Address-URL AVP (AVP Code 667) is of type UTF8String and
defines the address of the redirect server with which the end user is
to be connected when the account cannot cover the service cost. The
address type is in the form of a Uniform Resource Locator, as defined
in [<a href="./rfc3986" title=""Uniform Resource Identifier (URI): Generic Syntax"">RFC3986</a>]. Note that individual URL schemes may restrict the
contents of the UTF8String.
<span class="h3"><a class="selflink" id="section-8.67" href="#section-8.67">8.67</a>. Redirect-Address-SIP-URI AVP</span>
The Redirect-Address-SIP-URI AVP (AVP Code 668) is of type UTF8String
and defines the address of the redirect server with which the end
user is to be connected when the account cannot cover the service
cost. The address type is in the form of a SIP Uniform Resource
Identifier, as defined in [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>].
<span class="h3"><a class="selflink" id="section-8.68" href="#section-8.68">8.68</a>. QoS-Final-Unit-Indication AVP</span>
The QoS-Final-Unit-Indication AVP (AVP Code 669) is of type Grouped
and indicates that the Granted-Service-Unit AVP in the
Credit-Control-Answer or in the AA-Answer contains the final units
for the service. After these units have expired, the Diameter
Credit-Control client is responsible for executing the action
indicated in the Final-Unit-Action AVP (see <a href="#section-5.6">Section 5.6</a>).
If more than one unit type is received in the Credit-Control-Answer,
the unit type that first expired SHOULD cause the credit-control
client to execute the specified action.
In the first interrogation, the QoS-Final-Unit-Indication AVP with
Final-Unit-Action set to REDIRECT or RESTRICT_ACCESS can also be
present with no Granted-Service-Unit AVP in the Credit-Control-Answer
or in the AA-Answer. This indicates to the Diameter Credit-Control
client that the client is to execute the specified action
<span class="grey">Bertz, et al. Standards Track [Page 89]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-90" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
immediately. If the home service provider policy is to terminate the
service, naturally, the server SHOULD return the appropriate
transient failure (see <a href="#section-9.1">Section 9.1</a>) in order to implement the
policy-defined action.
The Final-Unit-Action AVP defines the behavior of the Service Element
when the user's account cannot cover the cost of the service and MUST
always be present if the QoS-Final-Unit-Indication AVP is included in
a command.
If the Final-Unit-Action AVP is set to TERMINATE, the QoS-Final-Unit-
Indication group AVP MUST NOT contain any other AVPs.
If the Final-Unit-Action AVP is set to REDIRECT, then the Redirect-
Server-Extension AVP MUST be present. The Filter-Rule AVP or the
Filter-Id AVP MAY be present in the Credit-Control-Answer message if
the user is also allowed to access other services that are not
accessible through the address given in the Redirect-Server-Extension
AVP or if access to these services needs to be limited in some way
(e.g., QoS).
If the Final-Unit-Action AVP is set to RESTRICT_ACCESS, either the
Filter-Rule AVP or the Filter-Id AVP SHOULD be present.
The Filter-Rule AVP is defined in [<a href="./rfc5777" title=""Traffic Classification and Quality of Service (QoS) Attributes for Diameter"">RFC5777</a>]. The Filter-Rule AVP can
be used to define a specific combination of a condition and an
action. If used only with traffic conditions, it should define which
traffic should be allowed when no more service units are granted.
However, if QoS or treatment information exists in the AVP, these
actions should be executed, e.g., limiting the allowed traffic with
certain QoS information. When multiple Filter-Rule AVPs exist,
precedence should be determined as defined in [<a href="./rfc5777" title=""Traffic Classification and Quality of Service (QoS) Attributes for Diameter"">RFC5777</a>].
The Filter-Id AVP is defined in [<a href="./rfc7155" title=""Diameter Network Access Server Application"">RFC7155</a>]. The Filter-Id AVP can be
used to reference an IP filter list installed in the access device by
means other than the Diameter Credit-Control application, e.g.,
locally configured or configured by another entity.
If the Final-Unit-Action AVP is (1) set to TERMINATE, (2) set to
RESTRICT_ACCESS and the action required is to allow only traffic that
could be classified using an IPFilterRule, or (3) set to REDIRECT
using a type that is one of the types in the Redirect-Address-Type
AVP, then the credit-control server SHOULD send the information in
the Final-Unit-Indication AVP, in addition to or instead of the
QoS-Final-Unit-Indication AVP. This is done in order to preserve
backward compatibility with credit-control clients that support only
[<a href="./rfc4006" title=""Diameter Credit-Control Application"">RFC4006</a>].
<span class="grey">Bertz, et al. Standards Track [Page 90]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-91" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
The QoS-Final-Unit-Indication AVP is defined as follows (per
grouped-avp-def as defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]):
QoS-Final-Unit-Indication ::= < AVP Header: 669 >
{ Final-Unit-Action }
*[ Filter-Rule ]
*[ Filter-Id ]
[ Redirect-Server-Extension ]
*[ AVP ]
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. Result-Code AVP Values</span>
This section defines new Result-Code AVP [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>] values that must
be supported by all Diameter implementations that conform to this
specification.
The Credit-Control-Answer message includes the Result-Code AVP, which
may indicate that an error was present in the Credit-Control-Request
message. A rejected Credit-Control-Request message SHOULD cause the
user's session to be terminated.
<span class="h3"><a class="selflink" id="section-9.1" href="#section-9.1">9.1</a>. Transient Failures</span>
Errors that fall within the category of transient failures are used
to inform the peer that the request could not be satisfied at the
time it was received but that the request MAY be able to be satisfied
in the future.
DIAMETER_END_USER_SERVICE_DENIED 4010
The credit-control server denies the service request due to service
restrictions. If the CCR contained used service units, they are
deducted, if possible.
DIAMETER_CREDIT_CONTROL_NOT_APPLICABLE 4011
The credit-control server determines that the service can be granted
to the end user but that no further credit-control is needed for the
service (e.g., the service is free of charge).
DIAMETER_CREDIT_LIMIT_REACHED 4012
The credit-control server denies the service request because the
end user's account could not cover the requested service. If the CCR
contained used service units, they are deducted, if possible.
<span class="grey">Bertz, et al. Standards Track [Page 91]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-92" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-9.2" href="#section-9.2">9.2</a>. Permanent Failures</span>
Errors that fall within the category of permanent failures are used
to inform the peer that the request failed and should not be
attempted again.
DIAMETER_USER_UNKNOWN 5030
The specified end user is unknown in the credit-control server.
DIAMETER_RATING_FAILED 5031
This error code is used to inform the credit-control client that the
credit-control server cannot rate the service request due to
insufficient rating input, an incorrect AVP combination, or an AVP or
AVP value that is not recognized or supported in the rating. The
Failed-AVP AVP MUST be included and contain (1) a copy of the entire
AVP or AVPs that could not be processed successfully or (2) an
example of the missing AVP, complete with the Vendor-Id if
applicable. The value field of the missing AVP should be of correct
minimum length and contain zeros.
<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. AVP Occurrence Table</span>
The table in <a href="#section-10.1">Section 10.1</a> presents the AVPs defined in this document
and specifies in which Diameter messages they MAY or MUST NOT be
present. Note that AVPs that can only be present within a Grouped
AVP are not represented in the table.
The table uses the following symbols:
0 The AVP MUST NOT be present in the message.
0+ Zero or more instances of the AVP MAY be present in the
message.
0-1 Zero or one instance of the AVP MAY be present in the
message. It is considered an error if there is more
than one instance of the AVP.
1 One instance of the AVP MUST be present in the message.
<span class="grey">Bertz, et al. Standards Track [Page 92]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-93" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-10.1" href="#section-10.1">10.1</a>. Credit-Control AVP Table</span>
The table in this section is used to represent which credit-control
application-specific AVPs defined in this document are to be present
in the credit-control messages.
+-----------+
| Command |
| Code |
|-----+-----+
Attribute Name | CCR | CCA |
----------------------------------|-----+-----+
Acct-Multi-Session-Id | 0-1 | 0-1 |
Auth-Application-Id | 1 | 1 |
CC-Correlation-Id | 0-1 | 0 |
CC-Session-Failover | 0 | 0-1 |
CC-Request-Number | 1 | 1 |
CC-Request-Type | 1 | 1 |
CC-Sub-Session-Id | 0-1 | 0-1 |
Check-Balance-Result | 0 | 0-1 |
Cost-Information | 0 | 0-1 |
Credit-Control-Failure-Handling | 0 | 0-1 |
Destination-Host | 0-1 | 0 |
Destination-Realm | 1 | 0 |
Direct-Debiting-Failure-Handling | 0 | 0-1 |
Event-Timestamp | 0-1 | 0-1 |
Failed-AVP | 0 | 0+ |
Final-Unit-Indication | 0 | 0-1 |
QoS-Final-Unit-Indication | 0 | 0-1 |
Granted-Service-Unit | 0 | 0-1 |
Multiple-Services-Credit-Control | 0+ | 0+ |
Multiple-Services-Indicator | 0-1 | 0 |
Origin-Host | 1 | 1 |
Origin-Realm | 1 | 1 |
Origin-State-Id | 0-1 | 0-1 |
Proxy-Info | 0+ | 0+ |
Redirect-Host | 0 | 0+ |
Redirect-Host-Usage | 0 | 0-1 |
Redirect-Max-Cache-Time | 0 | 0-1 |
Requested-Action | 0-1 | 0 |
Requested-Service-Unit | 0-1 | 0 |
Route-Record | 0+ | 0+ |
Result-Code | 0 | 1 |
Service-Context-Id | 1 | 0 |
Service-Identifier | 0-1 | 0 |
Service-Parameter-Info | 0+ | 0 |
Session-Id | 1 | 1 |
Subscription-Id | 0+ | 0 |
<span class="grey">Bertz, et al. Standards Track [Page 93]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-94" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Subscription-Id-Extension | 0+ | 0 |
Termination-Cause | 0-1 | 0 |
User-Equipment-Info | 0-1 | 0 |
User-Equipment-Info-Extension | 0-1 | 0 |
Used-Service-Unit | 0+ | 0 |
User-Name | 0-1 | 0-1 |
Validity-Time | 0 | 0-1 |
----------------------------------|-----+-----+
<span class="h3"><a class="selflink" id="section-10.2" href="#section-10.2">10.2</a>. Re-Auth-Request/Re-Auth-Answer AVP Table</span>
This section defines AVPs that are specific to the Diameter
Credit-Control application and that MAY be included in the Diameter
Re-Auth-Request/Re-Auth-Answer (RAR/RAA) message [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>].
The RAR/RAA command MAY include the following additional AVPs:
+---------------+
| Command Code |
|-------+-------+
Attribute Name | RAR | RAA |
------------------------------+-------+-------+
CC-Sub-Session-Id | 0-1 | 0-1 |
G-S-U-Pool-Identifier | 0-1 | 0-1 |
Service-Identifier | 0-1 | 0-1 |
Rating-Group | 0-1 | 0-1 |
------------------------------+-------+-------+
<span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>. RADIUS/Diameter Credit-Control Interworking Model</span>
This section defines the basic principles for the Diameter
Credit-Control / RADIUS prepaid interworking model -- that is, a
message translation between a RADIUS-based prepaid solution and a
Diameter Credit-Control application. A complete description of the
protocol translations between RADIUS and the Diameter Credit-Control
application is beyond the scope of this specification and SHOULD be
addressed in another appropriate document.
The Diameter Credit-Control architecture may have a Translation Agent
capable of translation between RADIUS prepaid and Diameter
Credit-Control protocols. A AAA server (usually the home AAA server)
may act as a Translation Agent and as a Diameter Credit-Control
client for Service Elements that use credit-control mechanisms other
than Diameter Credit-Control -- for instance, RADIUS prepaid. In
this case, the home AAA server contacts the Diameter Credit-Control
server as part of the authorization process. The interworking
architecture is illustrated in Figure 9, and an interworking flow is
illustrated in Figure 10. In a roaming situation, the Service
<span class="grey">Bertz, et al. Standards Track [Page 94]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-95" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Element (e.g., the NAS) may be located in the visited network, and a
visited AAA server is usually contacted. The visited AAA server then
connects to the home AAA server.
RADIUS Prepaid
+--------+ +---------+ Protocol +------------+ +--------+
| End |<----->| Service |<---------->| Home AAA | |Business|
| User | | Element | | Server | |Support |
+--------+ +-->| | |+----------+|->|System |
| +---------+ ||CC Client || | |
| |+----------+| | |
+--------+ | +------^-----+ +----^---+
| End |<--+ Credit-Control | |
| User | Protocol | |
+--------+ +-------V--------+ |
|Credit-Control |----+
| Server |
+----------------+
Figure 9: Credit-Control Architecture with Service Element
Containing Translation Agent, Translating RADIUS Prepaid
to Diameter Credit-Control Protocol
When the AAA server acting as a Translation Agent receives an initial
RADIUS Access-Request message from a Service Element (e.g., NAS
access), it performs regular authentication and authorization. If
the RADIUS Access-Request message indicates that the Service Element
is capable of credit-control and if the home AAA server finds that
the subscriber is a prepaid subscriber, then a Diameter
Credit-Control-Request SHOULD be sent toward the credit-control
server to perform credit authorization and to establish a
credit-control session. After the Diameter Credit-Control server
checks the end user's account balance, rates the service, and
reserves credit from the end user's account, the reserved quota is
returned to the home AAA server in the Diameter Credit-Control-
Answer. The home AAA server then sends the reserved quota to the
Service Element in the RADIUS Access-Accept.
At the expiry of the allocated quota, the Service Element sends a new
RADIUS Access-Request containing the units used thus far to the home
AAA server. The home AAA server shall map a RADIUS Access-Request
containing the reported units to the Diameter Credit-Control server
in a Diameter Credit-Control-Request (UPDATE_REQUEST). The Diameter
Credit-Control server debits the used units from the end user's
account and allocates a new quota that is returned to the home AAA
server in the Diameter Credit-Control-Answer. The quota is
transferred to the Service Element in the RADIUS Access-Accept. When
the end user terminates the service or when the entire quota has been
<span class="grey">Bertz, et al. Standards Track [Page 95]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-96" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
used, the Service Element sends a RADIUS Access-Request. To debit
the used units from the end user's account and to stop the
credit-control session, the home AAA server sends a Diameter
Credit-Control-Request (TERMINATION_REQUEST) to the credit-control
server. The Diameter Credit-Control server acknowledges the session
termination by sending a Diameter Credit-Control-Answer to the home
AAA server. The RADIUS Access-Accept is sent to the NAS.
Figure 10 illustrates a Diameter Credit-Control / RADIUS prepaid
interworking sequence.
Service Element Translation Agent
(e.g., NAS) (CC Client) CC Server
| Access-Request | |
|----------------------->| |
| | CCR (Initial) |
| |----------------------->|
| | CCA (Granted-Units) |
| |<-----------------------|
| Access-Accept | |
| (Granted-Units) | |
|<-----------------------| |
: : :
| Access-Request | |
| (Used-Units) | |
|----------------------->| |
| | CCR (Update, |
| | Used-Units) |
| |----------------------->|
| | CCA (Granted-Units) |
| |<-----------------------|
| Access-Accept | |
| (Granted-Units) | |
|<-----------------------| |
: : :
| Access-Request | |
|----------------------->| |
| | CCR (Terminate, |
| | Used-Units) |
| |----------------------->|
| | CCA |
| |<-----------------------|
| Access-Accept | |
|<-----------------------| |
| | |
Figure 10: Message Flow Example with Diameter
Credit-Control / RADIUS Prepaid Interworking
<span class="grey">Bertz, et al. Standards Track [Page 96]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-97" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h2"><a class="selflink" id="section-12" href="#section-12">12</a>. IANA Considerations</span>
This document uses several registries that were originally created in
[<a href="./rfc4006" title=""Diameter Credit-Control Application"">RFC4006</a>] or the values assigned to existing namespaces managed by
IANA. IANA has updated these registries to reference this document.
The registries and their allocation policies are specified below.
<span class="h3"><a class="selflink" id="section-12.1" href="#section-12.1">12.1</a>. Application Identifier</span>
This specification assigns the value 4, "Diameter Credit Control", to
the "Application IDs" namespace defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]. See
<a href="#section-1.3">Section 1.3</a> for more information.
<span class="h3"><a class="selflink" id="section-12.2" href="#section-12.2">12.2</a>. Command Codes</span>
This specification uses the value 272 from the "Command Codes"
namespace defined in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>] for the Credit-Control-Request (CCR)
and Credit-Control-Answer (CCA) commands.
<span class="h3"><a class="selflink" id="section-12.3" href="#section-12.3">12.3</a>. AVP Codes</span>
See <a href="#section-8">Section 8</a> for the assignments in this specification.
This document describes new AVP codes beyond those described in
[<a href="./rfc4006" title=""Diameter Credit-Control Application"">RFC4006</a>]. IANA has allocated codes for the AVPs listed in Table 7.
<span class="grey">Bertz, et al. Standards Track [Page 97]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-98" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
+-----------------------------------+------+--------------+
| Attribute Name | Code | Defined in |
+-----------------------------------+------+--------------+
| User-Equipment-Info-Extension | 653 | <a href="#section-8.52">Section 8.52</a> |
| User-Equipment-Info-IMEISV | 654 | <a href="#section-8.53">Section 8.53</a> |
| User-Equipment-Info-MAC | 655 | <a href="#section-8.54">Section 8.54</a> |
| User-Equipment-Info-EUI64 | 656 | <a href="#section-8.55">Section 8.55</a> |
| User-Equipment-Info-ModifiedEUI64 | 657 | <a href="#section-8.56">Section 8.56</a> |
| User-Equipment-Info-IMEI | 658 | <a href="#section-8.57">Section 8.57</a> |
| Subscription-Id-Extension | 659 | <a href="#section-8.58">Section 8.58</a> |
| Subscription-Id-E164 | 660 | <a href="#section-8.59">Section 8.59</a> |
| Subscription-Id-IMSI | 661 | <a href="#section-8.60">Section 8.60</a> |
| Subscription-Id-SIP-URI | 662 | <a href="#section-8.61">Section 8.61</a> |
| Subscription-Id-NAI | 663 | <a href="#section-8.62">Section 8.62</a> |
| Subscription-Id-Private | 664 | <a href="#section-8.63">Section 8.63</a> |
| Redirect-Server-Extension | 665 | <a href="#section-8.64">Section 8.64</a> |
| Redirect-Address-IPAddress | 666 | <a href="#section-8.65">Section 8.65</a> |
| Redirect-Address-URL | 667 | <a href="#section-8.66">Section 8.66</a> |
| Redirect-Address-SIP-URI | 668 | <a href="#section-8.67">Section 8.67</a> |
| QoS-Final-Unit-Indication | 669 | <a href="#section-8.68">Section 8.68</a> |
+-----------------------------------+------+--------------+
Table 7: Requested AVP Assignments
<span class="h3"><a class="selflink" id="section-12.4" href="#section-12.4">12.4</a>. Result-Code AVP Values</span>
This specification assigns the values 4010, 4011, and 4012 in the
"Result-Code AVP Values (code 268) - Transient Failures" namespace
and values 5030 and 5031 in the "Result-Code AVP Values (code 268) -
Permanent Failure" namespace, both of which were defined by
[<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]. See <a href="#section-9">Section 9</a> for the assignments in this specification.
<span class="h3"><a class="selflink" id="section-12.5" href="#section-12.5">12.5</a>. CC-Request-Type AVP</span>
As defined in <a href="#section-8.3">Section 8.3</a>, the CC-Request-Type AVP includes
Enumerated type values 1-4. IANA has created and is maintaining a
namespace for this AVP. The definition of new values is subject to
the Specification Required policy [<a href="./rfc8126" title="">RFC8126</a>] and conditions for
enumerated values described in <a href="./rfc7423#section-5.6">[RFC7423], Section 5.6</a>.
<span class="h3"><a class="selflink" id="section-12.6" href="#section-12.6">12.6</a>. CC-Session-Failover AVP</span>
As defined in <a href="#section-8.4">Section 8.4</a>, the CC-Session-Failover AVP includes
Enumerated type values 0-1. IANA has created and is maintaining a
namespace for this AVP. The definition of new values is subject to
the Specification Required policy [<a href="./rfc8126" title="">RFC8126</a>] and conditions for
enumerated values described in <a href="./rfc7423#section-5.6">[RFC7423], Section 5.6</a>.
<span class="grey">Bertz, et al. Standards Track [Page 98]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-99" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-12.7" href="#section-12.7">12.7</a>. CC-Unit-Type AVP</span>
As defined in <a href="#section-8.32">Section 8.32</a>, the CC-Unit-Type AVP includes Enumerated
type values 0-5. IANA has created and is maintaining a namespace for
this AVP. The definition of new values is subject to the
Specification Required policy [<a href="./rfc8126" title="">RFC8126</a>] and conditions for enumerated
values described in <a href="./rfc7423#section-5.6">[RFC7423], Section 5.6</a>.
<span class="h3"><a class="selflink" id="section-12.8" href="#section-12.8">12.8</a>. Check-Balance-Result AVP</span>
As defined in <a href="#section-8.6">Section 8.6</a>, the Check-Balance-Result AVP includes
Enumerated type values 0-1. IANA has created and is maintaining a
namespace for this AVP. The definition of new values is subject to
the Specification Required policy [<a href="./rfc8126" title="">RFC8126</a>] and conditions for
enumerated values described in <a href="./rfc7423#section-5.6">[RFC7423], Section 5.6</a>.
<span class="h3"><a class="selflink" id="section-12.9" href="#section-12.9">12.9</a>. Credit-Control AVP</span>
As defined in <a href="#section-8.13">Section 8.13</a>, the Credit-Control AVP includes
Enumerated type values 0-1. IANA has created and is maintaining a
namespace for this AVP. The definition of new values is subject to
the Specification Required policy [<a href="./rfc8126" title="">RFC8126</a>] and conditions for
enumerated values described in <a href="./rfc7423#section-5.6">[RFC7423], Section 5.6</a>.
<span class="h3"><a class="selflink" id="section-12.10" href="#section-12.10">12.10</a>. Credit-Control-Failure-Handling AVP</span>
As defined in <a href="#section-8.14">Section 8.14</a>, the Credit-Control-Failure-Handling AVP
includes Enumerated type values 0-2. IANA has created and is
maintaining a namespace for this AVP. The definition of new values
is subject to the Specification Required policy [<a href="./rfc8126" title="">RFC8126</a>] and
conditions for enumerated values described in <a href="./rfc7423#section-5.6">[RFC7423], Section 5.6</a>.
<span class="h3"><a class="selflink" id="section-12.11" href="#section-12.11">12.11</a>. Direct-Debiting-Failure-Handling AVP</span>
As defined in <a href="#section-8.15">Section 8.15</a>, the Direct-Debiting-Failure-Handling AVP
includes Enumerated type values 0-1. IANA has created and is
maintaining a namespace for this AVP. The definition of new values
is subject to the Specification Required policy [<a href="./rfc8126" title="">RFC8126</a>] and
conditions for enumerated values described in <a href="./rfc7423#section-5.6">[RFC7423], Section 5.6</a>.
<span class="h3"><a class="selflink" id="section-12.12" href="#section-12.12">12.12</a>. Final-Unit-Action AVP</span>
As defined in <a href="#section-8.35">Section 8.35</a>, the Final-Unit-Action AVP includes
Enumerated type values 0-2. IANA has created and is maintaining a
namespace for this AVP. The definition of new values is subject to
the Specification Required policy [<a href="./rfc8126" title="">RFC8126</a>] and conditions for
enumerated values described in <a href="./rfc7423#section-5.6">[RFC7423], Section 5.6</a>.
<span class="grey">Bertz, et al. Standards Track [Page 99]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-100" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-12.13" href="#section-12.13">12.13</a>. Multiple-Services-Indicator AVP</span>
As defined in <a href="#section-8.40">Section 8.40</a>, the Multiple-Services-Indicator AVP
includes Enumerated type values 0-1. IANA has created and is
maintaining a namespace for this AVP. The definition of new values
is subject to the Specification Required policy [<a href="./rfc8126" title="">RFC8126</a>] and
conditions for enumerated values described in <a href="./rfc7423#section-5.6">[RFC7423], Section 5.6</a>.
<span class="h3"><a class="selflink" id="section-12.14" href="#section-12.14">12.14</a>. Redirect-Address-Type AVP</span>
As defined in <a href="#section-8.38">Section 8.38</a>, the Redirect-Address-Type AVP includes
Enumerated type values 0-3. IANA has created and is maintaining a
namespace for this AVP. The definition of new values is subject to
the Specification Required policy [<a href="./rfc8126" title="">RFC8126</a>] and conditions for
enumerated values described in <a href="./rfc7423#section-5.6">[RFC7423], Section 5.6</a>.
<span class="h3"><a class="selflink" id="section-12.15" href="#section-12.15">12.15</a>. Requested-Action AVP</span>
As defined in <a href="#section-8.41">Section 8.41</a>, the Requested-Action AVP includes
Enumerated type values 0-3. IANA has created and is maintaining a
namespace for this AVP. The definition of new values is subject to
the Specification Required policy [<a href="./rfc8126" title="">RFC8126</a>] and conditions for
enumerated values described in <a href="./rfc7423#section-5.6">[RFC7423], Section 5.6</a>.
<span class="h3"><a class="selflink" id="section-12.16" href="#section-12.16">12.16</a>. Subscription-Id-Type AVP</span>
As defined in <a href="#section-8.47">Section 8.47</a>, the Subscription-Id-Type AVP includes
Enumerated type values 0-4. IANA has created and is maintaining a
namespace for this AVP. The definition of new values is subject to
the Specification Required policy [<a href="./rfc8126" title="">RFC8126</a>] and conditions for
enumerated values described in <a href="./rfc7423#section-5.6">[RFC7423], Section 5.6</a>.
<span class="h3"><a class="selflink" id="section-12.17" href="#section-12.17">12.17</a>. Tariff-Change-Usage AVP</span>
As defined in <a href="#section-8.27">Section 8.27</a>, the Tariff-Change-Usage AVP includes
Enumerated type values 0-2. IANA has created and is maintaining a
namespace for this AVP. The definition of new values is subject to
the Specification Required policy [<a href="./rfc8126" title="">RFC8126</a>] and conditions for
enumerated values described in <a href="./rfc7423#section-5.6">[RFC7423], Section 5.6</a>.
<span class="h3"><a class="selflink" id="section-12.18" href="#section-12.18">12.18</a>. User-Equipment-Info-Type AVP</span>
As defined in <a href="#section-8.50">Section 8.50</a>, the User-Equipment-Info-Type AVP includes
Enumerated type values 0-3. IANA has created and is maintaining a
namespace for this AVP. The definition of new values is subject to
the Specification Required policy [<a href="./rfc8126" title="">RFC8126</a>] and conditions for
enumerated values described in <a href="./rfc7423#section-5.6">[RFC7423], Section 5.6</a>.
<span class="grey">Bertz, et al. Standards Track [Page 100]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-101" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h2"><a class="selflink" id="section-13" href="#section-13">13</a>. Parameters Related to the Credit-Control Application</span>
Tx timer
When real-time credit-control is required, the credit-control
client contacts the credit-control server before and while the
service is provided to an end user. Due to the real-time nature
of the application, communication delays SHOULD be minimized,
e.g., to avoid an overly long service setup time experienced by
the end user. The Tx timer is introduced to control the waiting
time in the client in the Pending state. When the Tx timer
elapses, the credit-control client takes action for the end user
according to the value of the CCFH or the DDFH. The recommended
value is 10 seconds.
Tcc timer
The Tcc timer supervises an ongoing credit-control session in the
credit-control server. It is RECOMMENDED to use the Validity-Time
as input to set the Tcc timer value. In the case of transient
failures in the network, the Diameter Credit-Control server might
change to Idle state. To avoid this, the Tcc timer MAY be set so
that Tcc is equal to 2 x Validity-Time.
Credit-Control-Failure-Handling and Direct-Debiting-Failure-Handling
Client implementations may offer the possibility of locally
configuring these AVPs. In such a case, their values and behavior
are defined in Sections <a href="#section-5.7">5.7</a> and <a href="#section-6.5">6.5</a>, respectively.
<span class="h2"><a class="selflink" id="section-14" href="#section-14">14</a>. Security Considerations</span>
Security considerations regarding the Diameter protocol itself are
discussed in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>]. The use of this application of Diameter MUST
take into consideration the security issues and requirements of the
base protocol.
This application includes a mechanism for application-layer replay
protection by means of (1) the Session-Id AVP as specified in
[<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>] and (2) the CC-Request-Number AVP, which is specified in
this document. The Diameter Credit-Control application is often used
within one domain, and there may be a single hop between the peers.
In these environments, the use of TLS/TCP, DTLS/SCTP (Datagram
Transport Layer Security / Stream Control Transmission Protocol), or
IPsec is sufficient. The details of security considerations related
to TLS/TCP, DTLS/SCTP, and IPsec are discussed in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>].
<span class="grey">Bertz, et al. Standards Track [Page 101]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-102" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Because this application handles monetary transactions (directly or
indirectly), it increases interest in various security attacks.
Therefore, all parties communicating with each other MUST be
authenticated, including, for instance, TLS client-side
authentication. In addition, authorization of the client SHOULD be
emphasized, i.e., that the client is allowed to perform
credit-control for a certain user. The specific means of
authorization are outside the scope of this specification but can be,
for instance, manual configuration.
Another kind of threat is malicious modification, injection, or
deletion of AVPs or complete credit-control messages. The
credit-control messages contain sensitive billing-related information
(such as subscription identifiers, granted units, used units, or cost
information) whose malicious modification can have financial
consequences. Sometimes simply delaying the credit-control messages
can cause disturbances in the credit-control client or server.
Even without any modifications to the messages, an adversary that can
eavesdrop on transactions can obtain privacy-sensitive information.
Also, by monitoring the credit-control messages, one can collect
information about the credit-control server's billing models and
business relationships.
When third-party relays or proxies are involved, hop-by-hop security
does not necessarily provide sufficient protection for Diameter user
sessions. In some cases, it may be inappropriate to send Diameter
messages, such as CCR messages and CCA messages, containing sensitive
AVPs via untrusted Diameter proxy agents, as there are no assurances
that third-party proxies will not modify the credit-control commands
or AVP values.
<span class="h3"><a class="selflink" id="section-14.1" href="#section-14.1">14.1</a>. Direct Connection with Redirects</span>
A Diameter Credit-Control agent cannot always know whether agents
between it and the end user's Diameter Credit-Control server are
reliable. In this case, the Diameter Credit-Control agent doesn't
have a routing entry in its Diameter routing table (defined in
<a href="./rfc6733#section-2.7">[RFC6733], Section 2.7</a>) for the realm of the credit-control server in
the end user's home realm. The Diameter Credit-Control agent can
have a default route configured to a local redirect agent, and it
redirects the CCR message to the redirect agent. The local redirect
agent then returns a redirect notification (Result-Code 3006,
DIAMETER_REDIRECT_INDICATION) to the credit-control agent, as well as
information about the Diameter Credit-Control server(s) (Redirect-
Host AVP) and information about how the routing entry resulting from
the Redirect-Host is to be used (Redirect-Host-Usage AVP). The
Diameter Credit-Control agent then forwards the CCR message directly
<span class="grey">Bertz, et al. Standards Track [Page 102]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-103" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
to one of the hosts identified by the CCA message from the redirect
agent. If the value of the Redirect-Host-Usage AVP does not equal
zero, all subsequent messages are sent to the host specified in the
Redirect-Host AVP until the time specified by the Redirect-Max-Cache-
Time AVP has expired.
Even with redirects, there are some authorization issues. There may
be attacks toward nodes that have been properly authorized but that
abuse their authorization or have been compromised. These issues are
discussed more widely in <a href="./rfc4072#section-8">[RFC4072], Section 8</a>.
<span class="h3"><a class="selflink" id="section-14.2" href="#section-14.2">14.2</a>. Application-Level Redirects</span>
This document includes a redirection feature (<a href="#section-5.6.2">Section 5.6.2</a>) whereby
the service provider can redirect (in an application-specific way)
the end user to an alternate location when their credits have
expired. This technique is useful in that it allows the user to
return to normal service quickly, but it also exposes additional
risks and attack surface. In particular, this redirection can
potentially occur at an arbitrary point in a user's session,
potentially without any additional contextual confirmation available
to the user that the redirection is driven by the network. This lack
of confirmation matters because, in many application protocols, the
communication peer is also capable of inducing redirection. When the
peer is an attacker, the redirection can be to an attacker-controlled
site. In particular, such sites may be "phishing" sites designed to
appear similar to legitimate payment sites in an attempt to obtain
users' payment information for fraudulent purposes. When users
become accustomed to such redirections, they may have difficulty
distinguishing such attacks from legitimate redirections.
Because of the potentially harmful consequences of arbitrary
redirection by an attacker (such as to phishing sites), it is
important for service providers to be aware of that risk and ensure
that their users are aware of it as well. Service providers should
follow industry best practices for the specific application-layer
protocol to reduce the chances that such attacks could be mistaken
for legitimate redirections. The details of such a practice are out
of scope for this document.
<span class="grey">Bertz, et al. Standards Track [Page 103]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-104" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h2"><a class="selflink" id="section-15" href="#section-15">15</a>. Privacy Considerations</span>
As the Diameter protocol, and especially the credit-control
application, deal with subscribers and their actions, extra care
should be taken regarding the privacy of the subscribers. Per
terminology used in [<a href="./rfc6973" title=""Privacy Considerations for Internet Protocols"">RFC6973</a>], both the credit-control client and the
credit-control server are intermediary entities, wherein the
subscribers' privacy may be compromised even if no security issues
exist, and only authorized entities have access to the privacy-
sensitive information.
<span class="h3"><a class="selflink" id="section-15.1" href="#section-15.1">15.1</a>. Privacy-Sensitive AVPs</span>
The privacy-sensitive AVPs listed in this section MUST NOT be sent
across non-trusted networks or Diameter agents without end-to-end
authentication and confidentiality protection, as described in
<a href="./rfc6733#section-13.3">[RFC6733], Section 13.3</a>.
The following AVPs contain privacy-sensitive information at different
levels:
1. CC-Correlation-Id AVP: may contain privacy-sensitive
information, as the service provider may encode personal
information that helps it correlate different subscriptions and
access technologies.
2. Check-Balance-Result AVP: contains information on the balance
status of the subscriber.
3. Currency-Code AVP: contains information on the subscriber's
locale.
4. Cost-Unit AVP: contains privacy-sensitive information for the
Cost-Information AVP, in human-readable format.
5. Service-Identifier AVP: may contain privacy-sensitive
information about the subscriber's Internet activity.
6. Rating-Group AVP: may contain privacy-sensitive information
about the subscriber's Internet activity.
7. Restriction-Filter-Rule AVP: the information inside IPFilterRule
may be used to infer services used by the subscriber.
<span class="grey">Bertz, et al. Standards Track [Page 104]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-105" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
8. Redirect-Server-Address AVP: the service provider might embed
personal information on the subscriber in the URL/URI (e.g., to
create a personalized message). However, the service provider
may instead anonymize the subscriber's identity in the URL/URI
and let the redirect server query the information directly.
Such anonymized information must not allow personal information
or the subscriber's identity to be easily guessed. Furthermore,
the service provider should treat the URL/URI schema itself as
confidential and make sure it cannot be inferred (1) from
observation of the traffic or (2) due to its trivial structure.
A trivial structure could allow an adversary to query/modify
personal information even without knowing the subscriber's
identity. Similar AVPs are Redirect-Address-URL and Redirect-
Address-SIP-URI.
9. Service-Context-Id AVP: depending on how the service provider
uses it, it may contain privacy-sensitive information about the
service (e.g., in a 3GPP network Service-Context-Id AVP, it has
a different value for packet switching, SMS, Multimedia Messages
(MMSs), etc.).
10. Service-Parameter-Info AVP: depending on how the service
provider uses it, it may contain privacy-sensitive information
about the subscriber (e.g., location).
11. Subscription-Id-Data AVP: contains the identity of the
subscriber. Similar AVPs are Subscription-Id-E164,
Subscription-Id-IMSI, Subscription-Id-SIP-URI, Subscription-Id-
NAI, and Subscription-Id-Private.
12. User-Equipment-Info-Value AVP: contains the identity of the
device of the subscriber. Similar AVPs are User-Equipment-Info-
IMEISV, User-Equipment-Info-MAC, User-Equipment-Info-EUI64,
User-Equipment-Info-ModifiedEUI64, and User-Equipment-Info-IMEI.
13. QoS-Final-Unit-Indication AVP: Grouped AVP that may contain
privacy-sensitive information in its sub-AVPs (e.g.,
IPFilterRule, redirect address).
Note that some AVPs that are used in this document are defined in
[<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>] and may contain privacy-sensitive information. These AVPs
are not listed above.
<span class="grey">Bertz, et al. Standards Track [Page 105]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-106" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-15.2" href="#section-15.2">15.2</a>. Data Minimization</span>
Due to the nature of the credit-control application, some personal
data and identity information must be stored in both the
credit-control client and the credit-control server. However, this
could be minimized by following these guidelines:
1. Data stored in the credit-control client does not need to persist
across sessions. All data could be deleted once the session ends
and could be reconstructed once a new session is initialized.
Note that while the credit-control server is usually owned by the
service provider with which the subscriber already has some
direct legal or business relationship (where the privacy level
could be agreed upon), this is not always true for a
credit-control client that may be owned by a third party.
2. Some information about the subscriber has to be stored in
persistent storage in the credit-control server (e.g., identity,
balance); however, per-transaction information does not have to
be stored in persistent storage, and per-session information may
be deleted from persistent storage once the session ends.
3. In some cases, per-transaction information has to be stored on
the credit-control server, client, or both, for regulatory,
auditability, or debugging reasons. However, this could be
minimized by following these guidelines:
A. Data retention does not need to exceed the required duration.
B. Transaction information could be aggregated in some cases
(e.g., prefer information per session over information per
rating-group; prefer hourly byte summary over per-transaction
byte counts).
C. If not strictly needed, information that is more sensitive
(e.g., location, equipment type) could be filtered out of
such logs. This information is often used to make rating
decisions, and in this case, the rating decisions should be
logged instead of the data used to make them.
D. Due to the reasons explained in the first guideline, the
credit-control server, rather than the credit-control client,
would be the preferred location for storing such transaction
information.
<span class="grey">Bertz, et al. Standards Track [Page 106]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-107" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-15.3" href="#section-15.3">15.3</a>. Diameter Agents</span>
Diameter agents, as described in [<a href="./rfc6733" title=""Diameter Base Protocol"">RFC6733</a>], may be owned by
third parties. If end-to-end security is supported between the
credit-control client and the credit-control server, the operator can
use it to encrypt privacy-sensitive AVPs (as listed in <a href="#section-15.1">Section 15.1</a>)
and prevent such information from leaking into the agent.
In some cases, the Diameter agent needs access to privacy-sensitive
AVPs, in order to make correct routing decisions or even to modify
the content of these AVPs. For example, a proxy agent may need to
look at the Subscription-Id-IMSI AVP, in order to extract the mobile
country and network codes of the user and use them to look up the
destination to which the request should be routed (see <a href="./rfc6733#section-2.8.2">Section 2.8.2
in [RFC6733]</a>). In such a case, the credit-control client and
credit-control server may use a mechanism that anonymizes the
identity of the subscriber, as well as a mechanism to encrypt other
AVPs not used by the agent.
<span class="h2"><a class="selflink" id="section-16" href="#section-16">16</a>. References</span>
<span class="h3"><a class="selflink" id="section-16.1" href="#section-16.1">16.1</a>. Normative References</span>
[<a id="ref-CE164">CE164</a>] International Telecommunication Union, "COMPLEMENT TO
ITU-T RECOMMENDATION E.164 (11/2010): LIST OF ITU-T
RECOMMENDATION E.164 ASSIGNED COUNTRY CODES",
November 2011, <<a href="https://www.itu.int/dms_pub/itu-t/opb/sp/T-SP-E.164D-11-2011-PDF-E.pdf">https://www.itu.int/dms_pub/itu-t/opb/sp/</a>
<a href="https://www.itu.int/dms_pub/itu-t/opb/sp/T-SP-E.164D-11-2011-PDF-E.pdf">T-SP-E.164D-11-2011-PDF-E.pdf</a>>.
[<a id="ref-CE212">CE212</a>] International Telecommunication Union, "COMPLEMENT TO
RECOMMENDATION ITU-T E.212 (09/2016): LIST OF MOBILE
COUNTRY OR GEOGRAPHICAL AREA CODES", February 2017,
<<a href="https://www.itu.int/dms_pub/itu-t/opb/sp/T-SP-E.212A-2017-PDF-E.pdf">https://www.itu.int/dms_pub/itu-t/opb/sp/</a>
<a href="https://www.itu.int/dms_pub/itu-t/opb/sp/T-SP-E.212A-2017-PDF-E.pdf">T-SP-E.212A-2017-PDF-E.pdf</a>>.
[<a id="ref-E164">E164</a>] International Telecommunication Union, "The international
public telecommunication numbering plan", ITU-T
Recommendation E.164, November 2010,
<<a href="https://www.itu.int/rec/T-REC-E.164/">https://www.itu.int/rec/T-REC-E.164/</a>>.
[<a id="ref-E212">E212</a>] International Telecommunication Union, "The international
identification plan for public networks and
subscriptions", ITU-T Recommendation E.212,
September 2016, <<a href="https://www.itu.int/rec/T-REC-E.212/en">https://www.itu.int/rec/T-REC-E.212/en</a>>.
<span class="grey">Bertz, et al. Standards Track [Page 107]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-108" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
[<a id="ref-EUI64">EUI64</a>] IEEE, "Guidelines for Use of Extended Unique Identifier
(EUI), Organizationally Unique Identifier (OUI), and
Company ID (CID)", August 2017,
<<a href="https://standards.ieee.org/content/dam/ieee-standards/standards/web/documents/tutorials/eui.pdf">https://standards.ieee.org/content/dam/</a>
<a href="https://standards.ieee.org/content/dam/ieee-standards/standards/web/documents/tutorials/eui.pdf">ieee-standards/standards/web/documents/tutorials/eui.pdf</a>>.
[<a id="ref-ISO4217">ISO4217</a>] ISO, "Codes for the representation of currencies",
ISO 4217:2015, 2015, <<a href="https://www.iso.org/iso-4217-currency-codes.html">https://www.iso.org/</a>
<a href="https://www.iso.org/iso-4217-currency-codes.html">iso-4217-currency-codes.html</a>>.
[<a id="ref-RFC791">RFC791</a>] Postel, J., "Internet Protocol", STD 5, <a href="./rfc791">RFC 791</a>,
DOI 10.17487/RFC0791, September 1981,
<<a href="https://www.rfc-editor.org/info/rfc791">https://www.rfc-editor.org/info/rfc791</a>>.
[<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>,
DOI 10.17487/RFC2119, March 1997,
<<a href="https://www.rfc-editor.org/info/rfc2119">https://www.rfc-editor.org/info/rfc2119</a>>.
[<a id="ref-RFC3261">RFC3261</a>] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston,
A., Peterson, J., Sparks, R., Handley, M., and E.
Schooler, "SIP: Session Initiation Protocol", <a href="./rfc3261">RFC 3261</a>,
DOI 10.17487/RFC3261, June 2002,
<<a href="https://www.rfc-editor.org/info/rfc3261">https://www.rfc-editor.org/info/rfc3261</a>>.
[<a id="ref-RFC3539">RFC3539</a>] Aboba, B. and J. Wood, "Authentication, Authorization and
Accounting (AAA) Transport Profile", <a href="./rfc3539">RFC 3539</a>,
DOI 10.17487/RFC3539, June 2003,
<<a href="https://www.rfc-editor.org/info/rfc3539">https://www.rfc-editor.org/info/rfc3539</a>>.
[<a id="ref-RFC3986">RFC3986</a>] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66,
<a href="./rfc3986">RFC 3986</a>, DOI 10.17487/RFC3986, January 2005,
<<a href="https://www.rfc-editor.org/info/rfc3986">https://www.rfc-editor.org/info/rfc3986</a>>.
[<a id="ref-RFC4006">RFC4006</a>] Hakala, H., Mattila, L., Koskinen, J-P., Stura, M., and
J. Loughney, "Diameter Credit-Control Application",
<a href="./rfc4006">RFC 4006</a>, DOI 10.17487/RFC4006, August 2005,
<<a href="https://www.rfc-editor.org/info/rfc4006">https://www.rfc-editor.org/info/rfc4006</a>>.
[<a id="ref-RFC4291">RFC4291</a>] Hinden, R. and S. Deering, "IP Version 6 Addressing
Architecture", <a href="./rfc4291">RFC 4291</a>, DOI 10.17487/RFC4291,
February 2006, <<a href="https://www.rfc-editor.org/info/rfc4291">https://www.rfc-editor.org/info/rfc4291</a>>.
<span class="grey">Bertz, et al. Standards Track [Page 108]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-109" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
[<a id="ref-RFC5777">RFC5777</a>] Korhonen, J., Tschofenig, H., Arumaithurai, M., Jones, M.,
Ed., and A. Lior, "Traffic Classification and Quality of
Service (QoS) Attributes for Diameter", <a href="./rfc5777">RFC 5777</a>,
DOI 10.17487/RFC5777, February 2010,
<<a href="https://www.rfc-editor.org/info/rfc5777">https://www.rfc-editor.org/info/rfc5777</a>>.
[<a id="ref-RFC5952">RFC5952</a>] Kawamura, S. and M. Kawashima, "A Recommendation for IPv6
Address Text Representation", <a href="./rfc5952">RFC 5952</a>,
DOI 10.17487/RFC5952, August 2010,
<<a href="https://www.rfc-editor.org/info/rfc5952">https://www.rfc-editor.org/info/rfc5952</a>>.
[<a id="ref-RFC6733">RFC6733</a>] Fajardo, V., Ed., Arkko, J., Loughney, J., and G. Zorn,
Ed., "Diameter Base Protocol", <a href="./rfc6733">RFC 6733</a>,
DOI 10.17487/RFC6733, October 2012,
<<a href="https://www.rfc-editor.org/info/rfc6733">https://www.rfc-editor.org/info/rfc6733</a>>.
[<a id="ref-RFC7155">RFC7155</a>] Zorn, G., Ed., "Diameter Network Access Server
Application", <a href="./rfc7155">RFC 7155</a>, DOI 10.17487/RFC7155, April 2014,
<<a href="https://www.rfc-editor.org/info/rfc7155">https://www.rfc-editor.org/info/rfc7155</a>>.
[<a id="ref-RFC7423">RFC7423</a>] Morand, L., Ed., Fajardo, V., and H. Tschofenig, "Diameter
Applications Design Guidelines", <a href="https://www.rfc-editor.org/bcp/bcp193">BCP 193</a>, <a href="./rfc7423">RFC 7423</a>,
DOI 10.17487/RFC7423, November 2014,
<<a href="https://www.rfc-editor.org/info/rfc7423">https://www.rfc-editor.org/info/rfc7423</a>>.
[<a id="ref-RFC7542">RFC7542</a>] DeKok, A., "The Network Access Identifier", <a href="./rfc7542">RFC 7542</a>,
DOI 10.17487/RFC7542, May 2015,
<<a href="https://www.rfc-editor.org/info/rfc7542">https://www.rfc-editor.org/info/rfc7542</a>>.
[<a id="ref-RFC8126">RFC8126</a>] Cotton, M., Leiba, B., and T. Narten, "Guidelines for
Writing an IANA Considerations Section in RFCs", <a href="https://www.rfc-editor.org/bcp/bcp26">BCP 26</a>,
<a href="./rfc8126">RFC 8126</a>, DOI 10.17487/RFC8126, June 2017,
<<a href="https://www.rfc-editor.org/info/rfc8126">https://www.rfc-editor.org/info/rfc8126</a>>.
[<a id="ref-RFC8174">RFC8174</a>] Leiba, B., "Ambiguity of Uppercase vs Lowercase in
<a href="./rfc2119">RFC 2119</a> Key Words", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc8174">RFC 8174</a>,
DOI 10.17487/RFC8174, May 2017,
<<a href="https://www.rfc-editor.org/info/rfc8174">https://www.rfc-editor.org/info/rfc8174</a>>.
[<a id="ref-TGPPIMEI">TGPPIMEI</a>] 3rd Generation Partnership Project, Technical
Specification Group Core Network, "Numbering, addressing
and identification (release 15)", 3GPP TS 23.003
version 15.6.0, December 2018.
<span class="grey">Bertz, et al. Standards Track [Page 109]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-110" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="section-16.2" href="#section-16.2">16.2</a>. Informative References</span>
[<a id="ref-RFC2866">RFC2866</a>] Rigney, C., "RADIUS Accounting", <a href="./rfc2866">RFC 2866</a>,
DOI 10.17487/RFC2866, June 2000,
<<a href="https://www.rfc-editor.org/info/rfc2866">https://www.rfc-editor.org/info/rfc2866</a>>.
[<a id="ref-RFC3580">RFC3580</a>] Congdon, P., Aboba, B., Smith, A., Zorn, G., and J. Roese,
"IEEE 802.1X Remote Authentication Dial In User Service
(RADIUS) Usage Guidelines", <a href="./rfc3580">RFC 3580</a>,
DOI 10.17487/RFC3580, September 2003,
<<a href="https://www.rfc-editor.org/info/rfc3580">https://www.rfc-editor.org/info/rfc3580</a>>.
[<a id="ref-RFC3725">RFC3725</a>] Rosenberg, J., Peterson, J., Schulzrinne, H., and
G. Camarillo, "Best Current Practices for Third Party Call
Control (3pcc) in the Session Initiation Protocol (SIP)",
<a href="https://www.rfc-editor.org/bcp/bcp85">BCP 85</a>, <a href="./rfc3725">RFC 3725</a>, DOI 10.17487/RFC3725, April 2004,
<<a href="https://www.rfc-editor.org/info/rfc3725">https://www.rfc-editor.org/info/rfc3725</a>>.
[<a id="ref-RFC4004">RFC4004</a>] Calhoun, P., Johansson, T., Perkins, C., Hiller, T., Ed.,
and P. McCann, "Diameter Mobile IPv4 Application",
<a href="./rfc4004">RFC 4004</a>, DOI 10.17487/RFC4004, August 2005,
<<a href="https://www.rfc-editor.org/info/rfc4004">https://www.rfc-editor.org/info/rfc4004</a>>.
[<a id="ref-RFC4072">RFC4072</a>] Eronen, P., Ed., Hiller, T., and G. Zorn, "Diameter
Extensible Authentication Protocol (EAP) Application",
<a href="./rfc4072">RFC 4072</a>, DOI 10.17487/RFC4072, August 2005,
<<a href="https://www.rfc-editor.org/info/rfc4072">https://www.rfc-editor.org/info/rfc4072</a>>.
[<a id="ref-RFC6973">RFC6973</a>] Cooper, A., Tschofenig, H., Aboba, B., Peterson, J.,
Morris, J., Hansen, M., and R. Smith, "Privacy
Considerations for Internet Protocols", <a href="./rfc6973">RFC 6973</a>,
DOI 10.17487/RFC6973, July 2013,
<<a href="https://www.rfc-editor.org/info/rfc6973">https://www.rfc-editor.org/info/rfc6973</a>>.
[<a id="ref-TGPPCHARG">TGPPCHARG</a>]
3rd Generation Partnership Project, Technical
Specification Group Services and System Aspects, "Service
aspects; Charging and Billing", 3GPP TS 22.115
version 15.5.0, September 2018.
<span class="grey">Bertz, et al. Standards Track [Page 110]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-111" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h2"><a class="selflink" id="appendix-A" href="#appendix-A">Appendix A</a>. Credit-Control Sequences</span>
<span class="h3"><a class="selflink" id="appendix-A.1" href="#appendix-A.1">A.1</a>. Flow I</span>
A credit-control flow for Network Access Services prepaid is shown in
Figure 11. The Diameter protocol application is implemented in the
Network Access Server (NAS) per [<a href="./rfc7155" title=""Diameter Network Access Server Application"">RFC7155</a>]. The focus of this flow is
on credit authorization.
NAS
End User (CC Client) AAA Server CC Server
|(1)User Logon |(2)AA-Request (CC AVPs) |
|------------------>|-------------------->| |
| | |(3)CCR(Initial, CC AVPs)
| | |-------------------->|
| | |(4)CCA(Granted-Units)|
| | |<--------------------|
| |(5)AA-Answer(Granted-Units) |
|(6)Access granted |<--------------------| |
|<----------------->| | |
| | | |
: : : :
| |(7)CCR(Update, Used-Units) |
| |-------------------->|(8)CCR |
| | | (Update, Used-Units)
| | |-------------------->|
| | |(9)CCA(Granted-Units)|
| |(10)CCA(Granted-Units)<--------------------|
| |<--------------------| |
: : : :
| (Auth. lifetime expires) | |
| |(11)AAR (CC AVP) | |
| |-------------------->| |
| | (12)AAA | |
| |<--------------------| |
: : : :
: : : :
<span class="grey">Bertz, et al. Standards Track [Page 111]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-112" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
|(13)User logoff | | |
|------------------>|(14)CCR(Term., Used-Units) |
| |-------------------->|(15)CCR |
| | | (Term., Used-Units)
| | |-------------------->|
| | | (16)CCA |
| | (17)CCA |<--------------------|
| |<--------------------| |
| |(18)STR | |
| |-------------------->| |
| | (19)STA | |
| |<--------------------| |
Figure 11: Flow I
The user logs on to the network (1). The Diameter NAS sends a
Diameter AA-Request (AAR) to the home Diameter AAA server (2). The
credit-control client populates the AAR with the Credit-Control AVP
set to CREDIT_AUTHORIZATION, and service-specific AVPs are included,
as usual [<a href="./rfc7155" title=""Diameter Network Access Server Application"">RFC7155</a>]. The home Diameter AAA server performs service-
specific authentication and authorization, as usual. The home
Diameter AAA server determines that the user is a prepaid user and
notices from the Credit-Control AVP that the NAS has credit-control
capabilities. It sends a Diameter Credit-Control-Request with
CC-Request-Type set to INITIAL_REQUEST to the Diameter Credit-Control
server to perform credit authorization (3) and to establish a
credit-control session. (The home Diameter AAA server may forward
service-specific AVPs received from the NAS as input for the rating
process.) The Diameter Credit-Control server checks the end user's
account balance, rates the service, and reserves credit from the
end user's account. The reserved quota is returned to the home
Diameter AAA server in the Diameter Credit-Control-Answer (4). The
home Diameter AAA server sends the reserved quota to the NAS in the
Diameter AA-Answer (AAA). Upon receiving the AA-Answer, the NAS
starts the credit-control session and starts monitoring the granted
units (5). The NAS grants access to the end user (6). At the expiry
of the allocated quota, the NAS sends a Diameter Credit-Control-
Request with CC-Request-Type set to UPDATE_REQUEST to the home
Diameter AAA server (7). This message contains the units used thus
far. The home Diameter AAA server forwards the CCR to the Diameter
Credit-Control server (8). The Diameter Credit-Control server debits
the used units from the end user's account and allocates a new quota
that is returned to the home Diameter AAA server in the Diameter
Credit-Control-Answer (9). The message is forwarded to the NAS (10).
During the ongoing credit-control session, the authorization lifetime
expires, and the authorization/authentication client in the NAS
performs service-specific re-authorization to the home Diameter AAA
server, as usual. The credit-control client populates the AAR with
<span class="grey">Bertz, et al. Standards Track [Page 112]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-113" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
the Credit-Control AVP set to RE_AUTHORIZATION, indicating that the
credit-control server shall not be contacted, as the credit
authorization is controlled by the burning rate of the granted units
(11). The home Diameter AAA server performs service-specific
re-authorization as usual and returns the AA-Answer to the NAS (12).
The end user logs off from the network (13). To debit the used units
from the end user's account and to stop the credit-control session,
the NAS sends a Diameter Credit-Control-Request with CC-Request-Type
set to TERMINATION_REQUEST to the home Diameter AAA server (14). The
home Diameter AAA server forwards the CCR to the credit-control
server (15). The Diameter Credit-Control server acknowledges the
session termination by sending a Diameter Credit-Control-Answer to
the home Diameter AAA server (16). The home Diameter AAA server
forwards the answer to the NAS (17). The STR/STA takes place between
the NAS and home Diameter AAA server, as usual (18), (19).
<span class="h3"><a class="selflink" id="appendix-A.2" href="#appendix-A.2">A.2</a>. Flow II</span>
Figure 12 provides an example of Diameter Credit-Control for SIP
sessions. Although the flow focuses on illustrating the usage of
credit-control messages, the SIP signaling is inaccurate, and the
diagram is not by any means an attempt to define a service provider's
SIP network. However, for the sake of this example, some assumptions
are made below.
<span class="grey">Bertz, et al. Standards Track [Page 113]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-114" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
SIP Proxy/Registrar AAA
A (CC Client) Server B CC Server
| (i) REGISTER | | | |
|------------->|(ii) | | |
| |------------->| | |
| |authentication & | |
| |authorization | | |
| |<-------------| | |
|(iii) 200 OK | | |
|<-------------| | |
: : : :
|(1) INVITE | :
|------------->|
| |(2) CCR (Initial, SIP-specific AVP) |
| |------------------------------------------->|
| |(3) CCA (Granted-Units) |
| |<-------------------------------------------|
| |(4) INVITE | |
| |---------------------------->| |
: : : :
| |(5) CCR (Update, Used-Units) |
| |------------------------------------------->|
| |(6) CCA (Granted-Units) |
| |<-------------------------------------------|
: : : :
|(7) BYE | | |
|------------->| | |
| |(8) BYE | |
| |---------------------------->| |
| |(9) CCR (Termination, Used-Units) |
| |------------------------------------------->|
| |(10) CCA () |
| |<-------------------------------------------|
| | | |
Figure 12: Flow II
Typically, prepaid services based, for example, on time usage for SIP
sessions require an entity in the service provider network to
intercept all the requests within the SIP dialog in order to detect
events, such as session establishment and session release, that are
essential for performing credit-control operations with the
credit-control server. Therefore, in this example, it is assumed
that the SIP Proxy adds a Record-Route header in the initial SIP
INVITE to make sure that all the future requests in the created
dialog traverse through it (for the definitions of "Record-Route" and
"dialog", please refer to [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>]). Finally, the degree of
<span class="grey">Bertz, et al. Standards Track [Page 114]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-115" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
credit-control measuring of the media by the proxy depends on the
business model design used in setting up the end system and proxies
in the SIP network.
The end user (SIP User Agent A) sends a REGISTER with credentials
(i). The SIP Proxy sends a request to the home AAA server to perform
multimedia authentication and authorization by using, for instance, a
Diameter multimedia application (ii). The home AAA server checks
that the credentials are correct and checks the user profile.
Eventually, a 200 OK response (iii) is sent to the User Agent. Note
that the authentication and authorization are valid for the
registration validity period duration (i.e., until re-registration is
performed). Several SIP sessions may be established without
re-authorization.
User Agent A sends an INVITE (1). The SIP Proxy sends a Diameter
Credit-Control-Request (INITIAL_REQUEST) to the Diameter
Credit-Control server (2). The Credit-Control-Request contains
information obtained from the SIP signaling describing the requested
service (e.g., calling party, called party, Session Description
Protocol (SDP) attributes). The Diameter Credit-Control server
checks the end user's account balance, rates the service, and
reserves credit from the end user's account. The reserved quota is
returned to the SIP Proxy in the Diameter Credit-Control-Answer (3).
The SIP Proxy forwards the SIP INVITE to User Agent B (4). B's phone
rings, and B answers. The media flows between them, and the SIP
Proxy starts measuring the quota. At the expiry of the allocated
quota, the SIP Proxy sends a Diameter Credit-Control-Request
(UPDATE_REQUEST) to the Diameter Credit-Control server (5). This
message contains the units used thus far. The Diameter
Credit-Control server debits the used units from the end user's
account and allocates new credit that is returned to the SIP Proxy in
the Diameter Credit-Control-Answer (6). The end user terminates the
service by sending a BYE message (7). The SIP Proxy forwards the BYE
message to User Agent B (8) and sends a Diameter Credit-Control-
Request (TERMINATION_REQUEST) to the credit-control server (9). The
Diameter Credit-Control server acknowledges the session termination
by sending a Diameter Credit-Control-Answer to the SIP Proxy (10).
<span class="grey">Bertz, et al. Standards Track [Page 115]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-116" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="appendix-A.3" href="#appendix-A.3">A.3</a>. Flow III</span>
A credit-control flow for Multimedia Messaging Service is shown in
Figure 13. The sender is charged as soon as the messaging server
successfully stores the message.
MMS Server
A (CC Client) B CC Server
|(1) Send MMS | | |
|--------------->| | |
| |(2) CCR (Event, DIRECT_DEBITING, |
| | MMS-specific AVP) |
| |-------------------------------->|
| |(3) CCA (Granted-Units) |
| |<--------------------------------|
|(4) Send MMS Ack| | |
|<---------------| | |
| |(5) Notify MMS | |
| |--------------->| |
: : : :
| |(6) Retrieve MMS| |
| |<---------------| |
| |(7) Retrieve MMS| |
| | Ack | |
| |--------------->| |
| | | |
Figure 13: Flow III
This is an example of Diameter Credit-Control for direct debiting
using the Multimedia Messaging Service environment. Although the
flow focuses on illustrating the usage of credit-control messages,
the MMS signaling is inaccurate, and the diagram is not by any means
an attempt to define a service provider's MMS configuration or
billing model.
End user A sends an MMS to the MMS server (1). The MMS server stores
the message and sends a Diameter Credit-Control-Request
(EVENT_REQUEST with Requested-Action set to DIRECT_DEBITING) to the
Diameter Credit-Control server (2). The Credit-Control-Request
contains information about the MMS message (e.g., size, recipient
address, image coding type). The Diameter Credit-Control server
checks the end user's account balance, rates the service, and debits
the service from the end user's account. The granted quota is
returned to the MMS server in the Diameter Credit-Control-Answer (3).
<span class="grey">Bertz, et al. Standards Track [Page 116]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-117" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
The MMS server acknowledges the successful reception of the MMS
message (4). The MMS server notifies the recipient about the new MMS
(5), and end user B retrieves the message from the MMS message store
(6), (7).
Note that the transfer of the MMS message can take an extended period
of time and can fail, in which case a recovery action is needed. The
MMS server should return the already-debited units to the user's
account by using the REFUND action described in <a href="#section-6.4">Section 6.4</a>.
<span class="h3"><a class="selflink" id="appendix-A.4" href="#appendix-A.4">A.4</a>. Flow IV</span>
Another credit-control flow for Multimedia Messaging Service is shown
in Figure 14. The recipient is charged at the time of message
delivery.
MMS Server
Content Server (CC Client) B CC Server
|(1) Send MMS | | |
|--------------->| | |
| |(2) CCR (Event, CHECK_BALANCE, |
| | MMS-specific AVP) |
| |-------------------------------->|
| |(3) CCA (ENOUGH_CREDIT) |
| |<--------------------------------|
|(4) Send MMS Ack| | |
|<---------------| | |
| |(5) Notify MMS | |
| |--------------->| |
: : : :
| |(6) Retrieve MMS| |
| |<---------------| |
| |(7) CCR (Event, DIRECT_DEBITING, |
| | MMS-specific AVP) |
| |-------------------------------->|
| |(8) CCA (Granted-Units) |
| |<--------------------------------|
| |(9) Retrieve MMS| |
| | Ack | |
| |--------------->| |
| | | |
Figure 14: Flow IV
<span class="grey">Bertz, et al. Standards Track [Page 117]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-118" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
This is an example of Diameter Credit-Control for direct debiting
using the Multimedia Messaging Service environment. Although the
flow focuses on illustrating the usage of credit-control messages,
the MMS signaling is inaccurate, and the diagram is not by any means
an attempt to define a service provider's MMS configuration or
billing model.
A content server sends an MMS to the MMS server (1), which stores the
message. The message recipient will be charged for the MMS message
in this case. As there can be a substantially long time between the
receipt of the message at the MMS server and the actual retrieval of
the message, the MMS server does not establish any credit-control
sessions to the Diameter Credit-Control server; rather, it first
performs only a balance check (without any credit reservations) by
sending a Diameter Credit-Control-Request (EVENT_REQUEST with
Requested-Action set to CHECK_BALANCE) to verify that end user B can
cover the cost for the MMS (2). The Diameter Credit-Control server
checks the end user's account balance and returns the answer to the
MMS server in the Diameter Credit-Control-Answer (3). The MMS server
acknowledges the successful reception of the MMS message (4). The
MMS server notifies the recipient of the new MMS (5), and after some
time end user B retrieves the message from the MMS message store (6).
The MMS server sends a Diameter Credit-Control-Request (EVENT_REQUEST
with Requested-Action set to DIRECT_DEBITING) to the Diameter
Credit-Control server (7). The Credit-Control-Request contains
information about the MMS message (e.g., size, recipient address,
coding type). The Diameter Credit-Control server checks the
end user's account balance, rates the service, and debits the service
from the end user's account. The granted quota is returned to the
MMS server in the Diameter Credit-Control-Answer (8). The MMS is
transferred to end user B (9).
Note that the transfer of the MMS message can take an extended period
of time and can fail, in which case a recovery action is needed. The
MMS server should return the already-debited units to the user's
account by using the REFUND action described in <a href="#section-6.4">Section 6.4</a>.
<span class="grey">Bertz, et al. Standards Track [Page 118]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-119" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="appendix-A.5" href="#appendix-A.5">A.5</a>. Flow V</span>
Figure 15 provides an example of an Advice of Charge (AoC) service
for a SIP call.
SIP Controller
User Agent A (CC Client) User Agent B CC Server
|(1)INVITE | | |
| User Agent B(SDP)| | |
|------------------>| | |
| |(2)CCR (Event, PRICE_ENQUIRY, |
| | SIP-specific AVPs) |
| |------------------------------->|
| |(3)CCA (Cost-Information) |
| |<-------------------------------|
|(4)MESSAGE(URL) | | |
|<------------------| | |
|(5)HTTP GET | | |
|------------------>| | |
|(6)HTTP POST | | |
|------------------>|(7)INVITE(SDP) | |
| |--------------->| |
| | (8)200 OK | |
| (9)200 OK |<---------------| |
|<------------------| | |
Figure 15: Flow V
This is an example of Diameter Credit-Control for SIP sessions.
Although the flow focuses on illustrating the usage of credit-control
messages, the SIP signaling is inaccurate, and the diagram is not by
any means an attempt to define a service provider's SIP network.
User Agent A can be either a postpaid or prepaid subscriber using the
AoC service. It is assumed that the SIP controller also has HTTP
capabilities and delivers an interactive AoC web page with, for
instance, the cost information, the details of the call derived from
the SDP, and a button to accept/not accept the charges. (There may
be many other ways to deliver AoC information; however, this flow
focuses on the use of the credit-control messages.) The user has
been authenticated and authorized prior to initiating the call and
has been subscribed to the AoC service.
User Agent A sends an INVITE with the SDP to User Agent B via the SIP
controller (1). The SIP controller determines that the user is
subscribed to an AoC service and sends a Diameter Credit-Control-
Request (EVENT_REQUEST with Requested-Action set to PRICE_ENQUIRY) to
the Diameter Credit-Control server (2). The Credit-Control-Request
<span class="grey">Bertz, et al. Standards Track [Page 119]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-120" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
contains SIP-specific AVPs derived from the SIP signaling, describing
the requested service (e.g., calling party, called party, SDP
attributes). The Diameter Credit-Control server determines the cost
of the service and returns the Credit-Control-Answer, including the
Cost-Information AVP (3). The SIP controller manufactures the AoC
web page with information received in SIP signaling and with the cost
information received from the credit-control server. It then sends a
SIP MESSAGE that contains a URL pointing to the AoC information web
page (4). Upon receipt of the SIP MESSAGE, User Agent A
automatically invokes the web browser that retrieves the AoC
information (5). The user clicks on the appropriate button to accept
the charges (6). The SIP controller continues the session and sends
the INVITE to User Agent B, which accepts the call (7), (8), (9).
<span class="h3"><a class="selflink" id="appendix-A.6" href="#appendix-A.6">A.6</a>. Flow VI</span>
Figure 16 illustrates a credit-control flow for the REFUND case. It
is assumed that there is a trusted relationship and secure connection
between the gaming server and the Diameter Credit-Control server.
The end user may be a prepaid subscriber or a postpaid subscriber.
Gaming Server
End User (CC Client) CC Server
| (1)Service Delivery | |
|<---------------------->| |
: : :
: : :
| |(2)CCR(Event, REFUND,Requested-
| |Service-Unit, Service-Parameter-Info)
| |----------------------->|
| | (3)CCA(Cost-Information)
| |<-----------------------|
| (4)Notification | |
|<-----------------------| |
Figure 16: Flow VI
While the end user is playing the game (1), they enter a new level
that entitles them to a bonus. The gaming server sends a Diameter
Credit-Control-Request (EVENT_REQUEST with Requested-Action set to
REFUND_ACCOUNT) to the Diameter Credit-Control server (2). The
Credit-Control-Request contains the Requested-Service-Unit AVP with
the CC-Service-Specific-Units containing the number of points the
user just won. The Service-Parameter-Info AVP is also included in
the request and specifies the service event to be rated (e.g., Tetris
Bonus). From information received, the Diameter Credit-Control
server determines the amount to be credited, refunds the user's
account, and returns the Credit-Control-Answer, including the
<span class="grey">Bertz, et al. Standards Track [Page 120]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-121" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Cost-Information AVP (3). The Cost-Information AVP indicates the
credited amount. At the first opportunity, the gaming server
notifies the end user of the credited amount (4).
<span class="h3"><a class="selflink" id="appendix-A.7" href="#appendix-A.7">A.7</a>. Flow VII</span>
Figure 17 provides an example of graceful service termination for a
SIP call. It is assumed that the call is set up so that the
controller is in the call as a B2BUA (Back-to-Back User Agent)
performing third-party call control (3PCC). Note that the SIP
signaling is inaccurate, as the focus of this flow is on graceful
service termination and credit-control authorization. Best practices
for 3PCC are defined in [<a href="./rfc3725" title=""Best Current Practices for Third Party Call Control (3pcc) in the Session Initiation Protocol (SIP)"">RFC3725</a>].
SIP Controller Top-Up
User Agent A (CC Client) Server User Agent B CC Server
| | | | |
| | (1)CCR(Update, Used-Units) | |
| |------------------------------------------>|
| | (2)CCA(Final-Unit, Redirect)|
| |<------------------------------------------|
: : : : :
: : : : :
| | (3)CCR(Update, Used-Units)| |
| |------------------------------------------>|
| | (3a)INVITE("hold") | |
| |--------------------------->| |
| | | (4)CCA(Validity-Time)|
| |<------------------------------------------|
| (5)INVITE | (6)INVITE | | |
|<---------------|------------->| | |
| (7)RTP | | |
|...............................| | |
| | (8)BYE | | |
| |<-------------| | |
| | (9)CCR(Update) | |
| |------------------------------------------>|
| | (10)CCA(Granted-Units)|
| |<------------------------------------------|
| (12)INVITE | (11)INVITE | |
|<---------------|--------------------------->| |
Figure 17: Flow VII
<span class="grey">Bertz, et al. Standards Track [Page 121]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-122" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
The call is ongoing between User Agents A and B; User Agent A has a
prepaid subscription. At the expiry of the allocated quota, the SIP
controller sends a Diameter Credit-Control-Request (UPDATE_REQUEST)
to the Diameter Credit-Control server (1). This message contains the
units used thus far. The Diameter Credit-Control server debits the
used units from the end user's account and allocates the final quota
returned to the SIP controller in the Diameter Credit-Control-Answer
(2). This message contains the Final-Unit-Indication AVP with
Final-Unit-Action set to REDIRECT, the Redirect-Address-Type set to
SIP URI, and the Redirect-Server-Address set to the top-up server
name (e.g., sip:sip-topup-server@domain.com). At the expiry of the
final allocated quota, the SIP controller sends a Diameter
Credit-Control-Request (UPDATE_REQUEST) to the Diameter
Credit-Control server (3) and places the called party on "hold" by
sending an INVITE with the appropriate connection address in the SDP
(3a). The Credit-Control-Request message contains the units used
thus far. The Diameter Credit-Control server debits the used units
from the end user's account but does not make any credit
reservations. The Credit-Control-Answer message, which contains the
Validity-Time to supervise the graceful service termination process,
is returned to the SIP controller (4). The SIP controller
establishes a SIP session between the prepaid user and the top-up
server (5), (6). The top-up server plays an announcement and prompts
the user to enter a credit card number and the amount of money to be
used to replenish the account (7). The top-up server validates the
credit card number, replenishes the user's account (using some means
outside the scope of this specification), and releases the SIP
session (8). The SIP controller can now assume that communication
between the prepaid user and the top-up server took place. It sends
a spontaneous Credit-Control-Request (UPDATE_REQUEST) to the Diameter
Credit-Control server to check whether the account has been
replenished (9). The Diameter Credit-Control server reserves credit
from the end user's account and returns the reserved quota to the SIP
controller in the Credit-Control-Answer (10). At this point, the SIP
controller reconnects the caller and the called party (11), (12).
<span class="grey">Bertz, et al. Standards Track [Page 122]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-123" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
<span class="h3"><a class="selflink" id="appendix-A.8" href="#appendix-A.8">A.8</a>. Flow VIII</span>
Figure 18 provides an example of graceful service termination
initiated when the first interrogation takes place because the user's
account is empty. In this example, the credit-control server
supports the server-initiated credit re-authorization. The Diameter
protocol application is implemented in the NAS per [<a href="./rfc7155" title=""Diameter Network Access Server Application"">RFC7155</a>].
NAS Top-Up CC
End User (CC Client) AAA Server Server Server
|(1)User Logon |(2)AA-Request (CC AVPs) | |
|------------------>|------------------->| | |
| | |(3)CCR(Initial, CC AVPs)
| | |------------------->|
| | |(4)CCA(Final-Unit, |
| | | Validity-Time)|
| | |<-------------------|
| |(5)AA-Answer(Final-Unit, Validity-Time) |
|(6)Limited access |<-------------------| | |
| granted | | | |
|<----------------->| | | |
| | | | |
| (7)TCP/HTTP | (8)TCP/HTTP | |
|<----------------->|<----------------------------->| |
| (9)Replenish account | |
|<------------------------------------------------->| |
| | | (10)RAR |
| |<-------------------|<-------------------|
| |(11)RAA | |
| |------------------->|------------------->|
| |(12)CCR(Update) | |
| |------------------->|(13)CCR(Update) |
| | |------------------->|
| | |(14)CCA(Granted-Units)
| |(15)CCA(Granted-Units)<------------------|
| |<-------------------| |
Figure 18: Flow VIII
The user logs on to the network (1). The Diameter NAS sends a
Diameter AA-Request (AAR) to the home Diameter AAA server (2). The
credit-control client populates the AAR with the Credit-Control AVP
set to CREDIT_AUTHORIZATION, and service-specific AVPs are included,
as usual [<a href="./rfc7155" title=""Diameter Network Access Server Application"">RFC7155</a>]. The home Diameter AAA server performs service-
specific authentication and authorization, as usual. The home
Diameter AAA server determines that the user has a prepaid
subscription and notices from the Credit-Control AVP that the NAS has
credit-control capabilities. It sends a Diameter Credit-Control-
<span class="grey">Bertz, et al. Standards Track [Page 123]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-124" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Request with CC-Request-Type set to INITIAL_REQUEST to the Diameter
Credit-Control server to perform credit authorization (3) and to
establish a credit-control session. (The home Diameter AAA server
may forward service-specific AVPs received from the NAS as input for
the rating process.) The Diameter Credit-Control server checks the
end user's account balance, determines that the account cannot cover
the cost of the service, and initiates graceful service termination.
The Credit-Control-Answer is returned to the home Diameter AAA server
(4). This message contains the Final-Unit-Indication AVP and the
Validity-Time AVP set to a reasonable amount of time, to give the
user a chance to replenish their account (e.g., 10 minutes). The
Final-Unit-Indication AVP includes the Final-Unit-Action set to
REDIRECT, the Redirect-Address-Type set to URL, and the Redirect-
Server-Address set to the HTTP top-up server name. The home Diameter
AAA server sends the received Credit-Control AVPs to the NAS in the
Diameter AA-Answer (5). Upon successful AAA, the NAS starts the
credit-control session and immediately starts graceful service
termination, as instructed by the server. The NAS grants limited
access to the user (6). The HTTP client software running in the
user's device opens the transport connection redirected by the NAS to
the top-up server (7), (8). An appropriate web page is provided for
the user where the user can enter the credit card number and the
amount of money to be used to replenish the account, along with a
notification message that they are granted unlimited access if the
replenishment operation will be successfully executed within, for
example, the next 10 minutes. The top-up server validates the credit
card number and replenishes the user's account (using some means
outside the scope of this specification) (9). After successful
account top-up, the credit-control server sends a Re-Auth-Request
message to the NAS (10). The NAS acknowledges the request by
returning the Re-Auth-Answer message (11) and initiates the credit
re-authorization by sending a Credit-Control-Request (UPDATE_REQUEST)
to the Diameter Credit-Control server (12), (13).
The Diameter Credit-Control server reserves credit from the
end user's account and returns the reserved quota to the NAS via the
home Diameter AAA server in the Credit-Control-Answer (14), (15).
The NAS removes the restriction applied by graceful service
termination and starts monitoring the granted units.
<span class="h3"><a class="selflink" id="appendix-A.9" href="#appendix-A.9">A.9</a>. Flow IX</span>
The Diameter Credit-Control application defines the Multiple-
Services-Credit-Control AVP, which can be used to support independent
credit-control of multiple services in a single credit-control
(sub-)session for Service Elements that have such capabilities. It
is possible to request and allocate resources as a credit pool that
is shared between services or rating-groups.
<span class="grey">Bertz, et al. Standards Track [Page 124]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-125" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Figure 19 illustrates a usage scenario where the credit-control
client and server support independent credit-control of multiple
services, as defined in <a href="#section-5.1.2">Section 5.1.2</a>. It is assumed that service-
identifiers, rating-groups, and their associated parameters (e.g., IP
5-tuples) are locally configured in the Service Element or
provisioned by an entity other than the credit-control server.
End User Service Element CC Server
(CC Client)
|(1)User logon | |
|------------------>|(2)CCR(Initial, Service-Id access, |
| | Access-specific AVPs, |
| | Multiple-Services-Indicator) |
| |------------------------------------------->|
| |(3)CCA(Multiple-Services-CC ( |
| | Granted-Units(Total-Octets), |
| | Service-Id access, |
| | Validity-Time, |
| | G-S-U-Pool-Reference(Pool-Id 1, |
| | Multiplier 10))) |
| |<-------------------------------------------|
: : :
|(4)Service-Request (Service 1) |
|------------------>|(5)CCR(Update, Multiple-Services-CC ( |
| | Requested-Units(), Service-Id 1, |
| | Rating-Group 1)) |
| |------------------------------------------->|
| |(6)CCA(Multiple-Services-CC ( |
| | Granted-Units(Time), |
| | Rating-Group 1, |
| | G-S-U-Pool-Reference(Pool-Id 1, |
| | Multiplier 1))) |
| |<-------------------------------------------|
: : :
|(7)Service-Request (Service 2) |
|------------------>| |
: : :
: : :
|(8)Service-Request (Services 3 & 4) |
|------------------>|(9)CCR(Update, Multiple-Services-CC ( |
| | Requested-Units(), Service-Id 3, |
| | Rating-Group 2), |
| | Multiple-Services-CC ( |
| | Requested-Units(), Service-Id 4, |
| | Rating-Group 3)) |
| |------------------------------------------->|
<span class="grey">Bertz, et al. Standards Track [Page 125]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-126" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
| |(10)CCA(Multiple-Services-CC ( |
| | Granted-Units(Total-Octets), |
| | Service-Id 3, Rating-Group 2, |
| | Validity-Time, |
| | G-S-U-Pool-Reference(Pool-Id 2, |
| | Multiplier 2)), |
| | Multiple-Services-CC ( |
| | Granted-Units(Total-Octets), |
| | Service-Id 4, Rating-Group 3 |
| | Validity-Time, |
| | Final-Unit-Ind.(Terminate), |
| | G-S-U-Pool-Reference(Pool-Id 2, |
| | Multiplier 5))) |
| |<-------------------------------------------|
: : :
: : :
| +--------------+ | |
| |Validity time | |(11)CCR(Update, |
| |expires for | | Multiple-Services-CC ( |
| |Service-Id | | Requested-Unit(), |
| | access | | Used-Units(In-Octets, Out-Octets), |
| +--------------+ | Service-Id access)) |
| |------------------------------------------->|
| |(12)CCA(Multiple-Services-CC ( |
| | Granted-Units(Total-Octets), |
| | Service-Id access, |
| | Validity-Time, |
| | G-S-U-Pool-Reference(Pool-Id 1, |
| | Multiplier 10))) |
| |<-------------------------------------------|
: : :
: : :
| +--------------+ | |
| |Total quota | |(13)CCR(Update, |
| |elapses for | | Multiple-Services-CC ( |
| |Pool 2: | | Requested-Unit(), |
| |Service 4 not | | Used-Units(In-Octets, Out-Octets),|
| |allowed, | | Service-Id 3, Rating-Group 2), |
| |Service 3 | | Multiple-Services-CC ( |
| |continues | | Used-Units(In-Octets, Out-Octets),|
| +--------------+ | Service-Id 4, Rating-Group 3)) |
| |------------------------------------------->|
| |(14)CCA(Multiple-Services-CC ( |
| | Result-Code 4011, |
| | Service-Id 3)) |
| |<-------------------------------------------|
: : :
: : :
<span class="grey">Bertz, et al. Standards Track [Page 126]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-127" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
|(15)User logoff | |
|------------------>|(16)CCR(Term., |
| | Multiple-Services-CC ( |
| | Used-Units(In-Octets, Out-Octets),|
| | Service-Id access), |
| | Multiple-Services-CC ( |
| | Used-Units(Time), |
| | Service-Id 1, Rating-Group 1), |
| | Multiple-Services-CC ( |
| | Used-Units(Time), |
| | Service-Id 2, Rating-Group 1)) |
| |------------------------------------------->|
| |(17)CCA(Term.) |
| |<-------------------------------------------|
Figure 19: Flow IX: Example of Independent Credit-Control of
Multiple Services in a Credit-Control (Sub-)Session
The user logs on to the network (1). The Service Element sends a
Diameter Credit-Control-Request with CC-Request-Type set to
INITIAL_REQUEST to the Diameter Credit-Control server to perform
credit authorization for the bearer service (e.g., Internet access
service) and to establish a credit-control session (2). In this
message, the credit-control client indicates support for independent
credit-control of multiple services within the session by including
the Multiple-Services-Indicator AVP. The Diameter Credit-Control
server checks the end user's account balance, with rating information
received from the client (i.e., Service-Id and access-specific AVPs);
rates the request; and reserves credit from the end user's account.
Suppose that the server reserves $5 and determines that the cost is
$1/MB. It then returns to the Service Element a Credit-Control-
Answer message that includes the Multiple-Services-Credit-Control AVP
with a quota of 5 MB associated to the Service-Id (access), to a
multiplier value of 10, and to Pool-Id 1 (3).
The user uses service 1 (4). The Service Element sends a Diameter
Credit-Control-Request with CC-Request-Type set to UPDATE_REQUEST to
the credit-control server to perform credit authorization for
service 1 (5). This message includes the Multiple-Services-Credit-
Control AVP to request service units for service 1 that belong to
Rating-Group 1. The Diameter Credit-Control server determines that
service 1 draws credit resources from the same account as the access
service (i.e., pool 1). It rates the request according to
Service-Id/rating-group and updates the existing reservation by
requesting more credit. Suppose that the server reserves $5 more
(now the reservation is $10) and determines that the cost is
$0.1/minute. The server authorizes the whole rating-group. It then
returns to the Service Element a Credit-Control-Answer message that
<span class="grey">Bertz, et al. Standards Track [Page 127]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-128" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
includes the Multiple-Services-Credit-Control AVP with a quota of
50 minutes associated to Rating-Group 1, to a multiplier value of 1,
and to Pool-Id 1 (6). The client adjusts the total amount of
resources for pool 1 according to the received quota, which gives S
for pool 1 = 100.
The user uses service 2, which belongs to the authorized rating-group
(Rating-Group 1) (7). Resources are then consumed from pool 1.
The user now requests services 3 and 4 as well, which are not
authorized (8). The Service Element sends a Diameter Credit-Control-
Request with CC-Request-Type set to UPDATE_REQUEST to the
credit-control server in order to perform credit authorization for
services 3 and 4 (9). This message includes two instances of the
Multiple-Services-Credit-Control AVP to request service units for
service 3 that belong to Rating-Group 2 and service units for
service 4 that belong to Rating-Group 3. The Diameter Credit-Control
server determines that services 3 and 4 draw credit resources from
another account (i.e., pool 2). It checks the end user's account
balance and, according to Service-Id/rating-group information, rates
the request. It then reserves credit from pool 2.
For example, the server reserves $5 and determines that service 3
costs $0.2/MB and service 4 costs $0.5/MB. The server authorizes
only services 3 and 4. It returns to the Service Element a
Credit-Control-Answer message that includes two instances of the
Multiple-Services-Credit-Control AVP (10). One instance grants a
quota of 12.5 MB associated to Service-Id 3 to a multiplier value
of 2 and to Pool-Id 2. The other instance grants a quota of 5 MB
associated to Service-Id 4 to a multiplier value of 5 and to
Pool-Id 2.
The server also determines that pool 2 is exhausted and service 4 is
not allowed to continue after these units will be consumed.
Therefore, the Final-Unit-Indication AVP with action TERMINATE is
associated to Service-Id 4. The client calculates the total amount
of resources that can be used for pool 2 according to the received
quotas and multipliers, which gives S for pool 2 = 50.
The Validity-Time for the access service expires. The Service
Element sends a Credit-Control-Request message to the server in order
to perform credit re-authorization for the Service-Id (access) (11).
This message carries one instance of the Multiple-Services-Credit-
Control AVP that includes the units used by this service. Suppose
that the total amount of used units is 4 MB. The client adjusts the
total amount of resources for pool 1 accordingly, which gives S for
pool 1 = 60.
<span class="grey">Bertz, et al. Standards Track [Page 128]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-129" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
The server deducts $4 from the user's account and updates the
reservation by requesting more credit. Suppose that the server
reserves $5 more (now the reservation is $11) and already knows the
cost of the Service-Id (access), which is $1/MB. It then returns to
the Service Element a Credit-Control-Answer message that includes the
Multiple-Services-Credit-Control AVP with a quota of 5 MB associated
to the Service-Id (access), to a multiplier value of 10, and to
Pool-Id 1 (12). The client adjusts the total amount of resources for
pool 1 according to the received quota, which gives S for
pool 1 = 110.
Services 3 and 4 consume the total amount of pool 2's credit
resources (i.e., C1*2 + C2*5 >= S). The Service Element immediately
starts the TERMINATE action for service 4 and sends a Credit-Control-
Request message with CC-Request-Type set to UPDATE_REQUEST to the
credit-control server in order to perform credit re-authorization for
service 3 (13). This message contains two instances of the Multiple-
Services-Credit-Control AVP to report the units used by services 3
and 4. The server deducts the last $5 from the user's account
(pool 2) and returns the answer with Result-Code 4011 in the
Multiple-Services-Credit-Control AVP to indicate that service 3 can
continue without credit-control (14).
The end user logs off from the network (15). To debit the used units
from the end user's account and to stop the credit-control session,
the Service Element sends a Diameter Credit-Control-Request with
CC-Request-Type set to TERMINATION_REQUEST to the credit-control
server (16). This message contains the units used by each service in
multiple instances of the Multiple-Services-Credit-Control AVP. The
used units are associated with the relevant Service-Identifier and
rating-group. The Diameter Credit-Control server debits the used
units to the user's account (pool 1) and acknowledges the session
termination by sending a Diameter Credit-Control-Answer to the
Service Element (17).
<span class="grey">Bertz, et al. Standards Track [Page 129]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-130" ></span>
<span class="grey"><a href="./rfc8506">RFC 8506</a> Diameter Credit-Control Application March 2019</span>
Acknowledgements
The original authors of <a href="./rfc4006">RFC 4006</a> are Harri Hakala, Leena Mattila,
Juha-Pekka Koskinen, Marco Stura, and John Loughney.
The authors would like to thank Bernard Aboba, Jari Arkko, Robert
Ekblad, Pasi Eronen, Benny Gustafsson, Robert Karlsson, Avi Lior,
Jussi Maki, Paco Marin, Jeff Meyer, Anne Narhi, John Prudhoe,
Christopher Richards, Juha Vallinen, and Mark Watson for their
comments and suggestions.
Authors' Addresses
Lyle Bertz (editor)
Sprint
6220 Sprint Parkway
Overland Park, KS 66251
United States of America
Email: lyleb551144@gmail.com
David Dolson (editor)
Sandvine
408 Albert Street
Waterloo, ON N2L 3V3
Canada
Email: ddolson@acm.org
Yuval Lifshitz (editor)
Sandvine
408 Albert Street
Waterloo, ON N2L 3V3
Canada
Email: yuvalif@yahoo.com
Bertz, et al. Standards Track [Page 130]
</pre>
|